Admin

Info about admin(s)

STAGING_URL: https://switchapi3.azurewebsites.net
LIVE_URL: https://switchapi.azurewebsites.net

Get admin info

GET https://switchapi3.azurewebsites.net/admin

This endpoint retrieves the details of the admin currently logged in.

Headers

Name	Type	Description
SWI-CID	string	Client ID
Authorization	string	Format for Authorization is Bearer token_string

200

{
    "message": "Admin retrieved successfully",
    "data": {
        "id": 11,
        "email": "[e-mail]",
        "role": "customer_success",
        "disabled": false,
        "locked": false,
        "has_changed_password": true,
        "password_expired": false
    }
}

Get admin by id

GET https://switchapi3.azurewebsites.net/admin/:id

This endpoint retrieves the admin by searching with the id

Path Parameters

Name	Type	Description
id	integer	admin id

Headers

Name	Type	Description
SWI-CID	string	Client ID
Authorization	string	Format for the Authorization is Bearer token_string

200

{
    "message": "Admin retrieved successfully",
    "data": {
        "id": 26,
        "email": "[e-mail]",
        "role": "admin",
        "disabled": false
    }
}

404

Create admin

POST https://switchapi3.azurewebsites.net/admin/new

This endpoint creates a new admin and sends a randomly generated password to the admin's email if creation is successful.

Headers

Name	Type	Description
SWI-CS	string	Payload checksum
SWI-CID	string	Client ID
Authorization	string	Format for the Authorization is Bearer token_string

Request Body

Name	Type	Description
email	string	admin email
role	string	Could be customer_success, banking_operations, admin or super_admin

201

{
    "message": "Admin created successfully",
    "data": {
        "id": 11,
        "email": "[e-mail]",
        "role": "admin",
        "disabled": false
    }
}

400

Get admin list

GET https://switchapi3.azurewebsites.net/admin/list

This endpoint retrieves the list of admins.

Query Parameters

Name	Type	Description
search_query	string	Query used to search admin's emails
page	string	Defaults to 1
per_page	string	Defaults to 20

Headers

Name	Type	Description
SWI-CID	string	Client ID
Authorization	string	Format for the Authorization is Bearer token_string

200

{
    "message": "Admins retrieved successfully",
    "data": [
        {
            "id": 26,
            "email": "[e-mail]",
            "role": "admin",
            "disabled": false
        },
        {
            "id": 12,
            "email": "[e-mail]",
            "role": "super_admin",
            "disabled": false
        },
        {
            "id": 11,
            "email": "[e-mail]",
            "role": "admin",
            "disabled": false
        },
        {
            "id": 8,
            "email": "[e-mail]",
            "role": "admin",
            "disabled": false
        },
        {
            "id": 7,
            "email": "[e-mail]",
            "role": "admin",
            "disabled": false
        },
        {
            "id": 6,
            "email": "[e-mail]",
            "role": "admin",
            "disabled": false
        },
        {
            "id": 5,
            "email": "[e-mail]",
            "role": "admin",
            "disabled": false
        },
        {
            "id": 4,
            "email": "[e-mail]",
            "role": "admin",
            "disabled": false
        }
    ],
    "meta": {
        "total": 8,
        "per_page": 20,
        "page": 1,
        "page_count": 1
    }
}

401

Disable admin

POST https://switchapi3.azurewebsites.net/admin/disable/:id

This endpoint allows super-admins to disable admins.

Path Parameters

Name	Type	Description
id	string	id of the admin

Headers

Name	Type	Description
SWI-CID	string	Client ID
Authorization	string	Format for Authorization is Bearer token_string

200

{
    "message": "Admin disabled successfully",
    "data": {
        "id": 5,
        "email": "[e-mail]",
        "role": "admin",
        "disabled": true
    }
}

400

403

404

Enable a disabled admin

POST https://switchapi3.azurewebsites.net/admin/enable/:id

This endpoint allows superadmins to enable disabled admins.

Path Parameters

Name	Type	Description
id	string	id of the admin

Headers

Name	Type	Description
SWI-CID	string	Client ID
Authorization	string	Format for Authorization is Bearer token_string

200

{
    "message": "Admin enabled successfully",
    "data": {
        "id": 5,
        "email": "[e-mail]",
        "role": "customer_success",
        "disabled": false
    }
}

400

404

Change Password

POST https://switchapi3.azurewebsites.net/admin/update_password

Change admin password.

Headers

Name	Type	Description
SWI-CS	string	Payload checksum
SWI-CID	string	Client ID
Authorization	string	Format for Authorization is Bearer token_string

Request Body

Name	Type	Description
current_password	string	The admin's current password
password	string	The new password
password_confirmation	string	password confirmation

200

{
    "message": "Admin password changed successfully",
    "data": {
        "id": 4,
        "email": "[e-mail]",
        "role": "super_admin",
        "disabled": false
    }
}

400

Reset Admin Password

POST https://switchapi3.azurewebsites.net/admin/reset_password/:id

This endpoint allows a super admin to reset an admin's password. The new password (which is randomly generated) is then sent to the admin's email.

Path Parameters

Name	Type	Description
id	string	The id of the admin whose password is to be reset

Headers

Name	Type	Description
SWI-CID	string	Client ID
Authorization	string	Format for Authorization is Bearer token_string

200

{
    "message": "password reset successfully"
}

401

404

Unlock Account

POST https://switchapi3.azurewebsites.net/admin/unlock/:id

This endpoint allows a super admin to send an unlock email to the locked admin's email address.

Path Parameters

Name	Type	Description
id	string	The id of the admin to be unlocked.

Headers

Name	Type	Description
SWI-CID	string	Client ID
Authorization	string	Format for Authorization is Bearer token_string

200

{
    "message": "unlock email has been sent to this admin's mail"
}

401

404

Update Role

POST https://switchapi3.azurewebsites.net/admin/role/:id

This endpoint allows a super admin to update the role of another admin.

Path Parameters

Name	Type	Description
id	string	The id of the admin

Headers

Name	Type	Description
SWI-CS	string	Payload checksum
SWI-CID	string	Client ID
Authorization	string	Format for Authorization is Bearer token.

Request Body

Name	Type	Description
role	string	Any of customer_success, banking_operations, admin or super_admin

200

{
    "message": "Admin role updated successfully",
    "data": {
        "id": "19",
        "email": "[e-mail]",
        "disabled": false,
        "role": "admin",
        "has_changed_password": false,
        "locked": false
    }
}

400