All REST Endpoints

Sort by

Task Path Method

Group by API

Background Jobs

Get Job Details

Method: get

Path: /cloudapi/restapi/bgjobs/{bgJobName}

Trigger a background job

Method: post

Path: /cloudapi/restapi/bgjobs/{bgJobName}

Background Jobs (v3)

Get Job Details

Method: get

Path: /cloudapi/restapi/v3/bgjobs/{bgJobName}

Trigger a background job

Method: post

Path: /cloudapi/restapi/v3/bgjobs/{bgJobName}

OAuth2

To Get OAuth2 Token

Method: get

Path: /cloudapi/restapi/oauth2/token

Roles

Get Application Roles

Method: get

Path: /cloudapi/restapi/roles

Roles (v3)

Get Application Roles

Method: get

Path: /cloudapi/restapi/v3/roles

User Audit Events

Get All Users Audit Events

Method: get

Path: /cloudapi/restapi/audits

Get Audit Events On Date Filter

Method: get

Path: /cloudapi/restapi/audits/from/{startDate}/to/{endDate}

Get Audit Events On Pagination Filter

Method: get

Path: /cloudapi/restapi/audits/page/{page}/count/{size}

Get Users Specific Audit Events

Method: get

Path: /cloudapi/restapi/audits/userEmail/{grantor}

User Audit Events (v3)

Get All Users Audit Events

Method: get

Path: /cloudapi/restapi/v3/audits

Get Audit Events On Date Filter

Method: get

Path: /cloudapi/restapi/v3/audits/from/{startDate}/to/{endDate}

Get Audit Events On Pagination Filter

Method: get

Path: /cloudapi/restapi/v3/audits/page/{page}/count/{size}

Get Users Specific Audit Events

Method: get

Path: /cloudapi/restapi/v3/audits/userEmail/{grantor}

User Management

This operation enables you to view, create, and provision users and edit user attributes. This service also allows other common actions like enabling, disabling, and unlocking a user record.

Create/Update Company

Method: post

Path: /cloudapi/restapi/user/companies/add-list

Create/Update users

Method: post

Path: /cloudapi/restapi/user

Enable/Disable users

Method: put

Path: /cloudapi/restapi/user/change-status

Export a Job's failed users

Method: get

Path: /cloudapi/restapi/user/status/{jobId}/draft

Export a Job's log

Method: get

Path: /cloudapi/restapi/user/status/{jobId}/log

Get all Users

Method: get

Path: /cloudapi/restapi/user

Get Job status

Method: get

Path: /cloudapi/restapi/user/status/{jobId}

Get User

Method: get

Path: /cloudapi/restapi/user/{userId}

Reset a User password (Random Value)

Method: put

Path: /cloudapi/restapi/user/{userId}/auto-reset-pwd

Reset Users passwords (Known Value)

Method: put

Path: /cloudapi/restapi/user/manual-reset-pwd/{isEmailPasswd}

Reset Users passwords (Random Value)

Method: put

Path: /cloudapi/restapi/user/auto-reset-pwd

Unlock Users

Method: put

Path: /cloudapi/restapi/user/change-lock

User Management (v2)

Enable/Disable users

Method: put

Path: /cloudapi/restapi/v2/user/change-status

User Management (v3)

Create/Update Company

Method: post

Path: /cloudapi/restapi/v3/user/companies/add-list

Create/Update users

Method: post

Path: /cloudapi/restapi/v3/user

Enable/Disable users

Method: put

Path: /cloudapi/restapi/v3/user/change-status

Export a Job's failed users

Method: get

Path: /cloudapi/restapi/v3/user/status/{jobId}/draft

Export a Job's log

Method: get

Path: /cloudapi/restapi/v3/user/status/{jobId}/log

Get all Users

Method: get

Path: /cloudapi/restapi/v3/user

Get Job status

Method: get

Path: /cloudapi/restapi/v3/user/status/{jobId}

Get User

Method: get

Path: /cloudapi/restapi/v3/user/{userId}

Reset a User password (Random Value)

Method: put

Path: /cloudapi/restapi/v3/user/{userId}/auto-reset-pwd

Reset Users passwords (Known Value)

Method: put

Path: /cloudapi/restapi/v3/user/manual-reset-pwd/{isEmailPasswd}

Reset Users passwords (Random Value)

Method: put

Path: /cloudapi/restapi/v3/user/auto-reset-pwd

Unlock Users

Method: put

Path: /cloudapi/restapi/v3/user/change-lock