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}

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 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