This API is used to get the list of all users available in the tenant and their respective roles.
This API is useful for clients' IT and Compliance teams to periodically audit and ensure that only authorized staff from their organization have access to Webex Campaign.
If a ‘username’ is provided in the API Request body, then the API will return information on that particular user and their user role. If no username is specified in the API Request body, then it will return information on all the users and their respective roles within their tenant.
Know your endpoint
Based on the domain you use to log in to Webex Campaign, the endpoint domain for your API varies.
Go to the Postman Collection section to learn how to import a Postman collection. Click the below button, If you already know how to import a postman collection.
Request Headers
The following table describes the request headers:
| Request Header | Description |
|---|---|
| content-Type | application/json |
| authorization | Access token or API Secret Key in Bearer format Example: Bearer $(key) |
Body Parameters
The following table describes the elements in the request body:
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| username | String | Conditionally Mandatory | Specifies the username. |
| user_email | String | Conditionally Mandatory | Specifies the user's email id. |
Request Example
Resource path: https://<client domain>/campaignapi/resources/v3/users/
or
https://<client domain>/campaignapi/resources/v3/users/?username=<username or email id>
//To get the details of all the users available under the tenant.
https://<client domain>/campaignapi/resources/v3/users/
// To get the details of a specific user available under the tenant.
https://<client domain>/campaignapi/resources/v3/users/?username=demouser
Response Parameters
This API will return the following response parameters:
| Parameter | Description |
|---|---|
| username | Returns the username. |
| user_email | Returns the user's email id. |
| display_name | Returns the user's display name. |
| role_id | Returns the role id. |
| role_desc | Returns the role description. |
| user_status | Returns the user's status. |
| role_status | Returns the user's role status. |
| user_last_login_date | Returns the user's last login date. |
| user_groups | Returns the group names to which the user belongs to. |
| user_last_modified_date | Returns the user's last modified date. |
| user_id | Returns the user id. |
| user_first_name | Returns the user's first name. |
| user_last_name | Returns the user's last name. |
| user_creation_date | Returns the date when the user was created. |
Failure Response Codes
The API will return code within the response as per the following table in case of failure scenarios.
| HTTP Status Code | Code within API Response | Description |
|---|---|---|
| 200 | 1010 | The request was not processed. |
| 401 | 430 | Authorization failed. This resource is not allowed to access using this TOKEN or KEY |
| 498 | Invalid token or Access token expired | |
| 405 | 405 | Method not supported |
| 429 | 429 | Too many requests. Throttle limit reached for the time window. |
| 499 | 499 | Request failed. Check the exact reason of failure in application code and description of error stream. |
| 500 | 500 | Internal server error |
| 1001 | Invalid input JSON | |
| 1002 | Mandatory field missing | |
| 1003 | Error accessing profile store |