Get All Users - GET /Users

Get details of all users.

Usage:

1. GET /Users and get details of all users
2. DELETE /Users/{id} and delete a user

URL

/cxrestapi/auth/Users

Method:

GET

Media Type (header):

Authorization: Bearer <access token value>
Accept: application/json;v=1.0

Parameters

None

Success Response:

Code: 200 Success

Error Response:

Code: 401 Unauthorized
Code: 403 Forbidden

Sample Response:

[
  {
    "id": 1,
    "userName": "admin",
    "lastLoginDate": "2018-07-17T13:48:06.6800933Z",
    "roleIds": [
      1
    ],
    "teamIds": [
      1,
      11,
      12
    ],
    "authenticationProviderId": 1,
    "firstName": "Inbal",
    "lastName": "Mon",
    "email": "admin@check.org",
    "phoneNumber": "",
    "cellPhoneNumber": "",
    "jobTitle": "Admin",
    "other": "",
    "country": "Algeria",
    "active": true,
    "expirationDate": "2021-03-04T07:55:58.0201439Z",
    "allowedIpList": [],
    "localeId": 1
  },
  {
    "id": 10,
    "userName": "Marci",
    "lastLoginDate": "2018-06-14T07:39:15.503093Z",
    "roleIds": [
      2
    ],
    "teamIds": [
      1,
      11,
      12,
      18
    ],
    "authenticationProviderId": 3,
    "firstName": "Marci",
    "lastName": "Mar",
    "email": "marci@check.org",
    "phoneNumber": "",
    "cellPhoneNumber": "",
    "jobTitle": "",
    "other": "",
    "country": "",
    "active": true,
    "expirationDate": null,
    "allowedIpList": [],
    "localeId": 1
  }
}

Notes:

Retrieves details of all users. Role Id (roleIds) is used in the Roles API, Team Id (teamIds) is used in the Teams API, Authentication Provider Id (authenticationProviderId) is used in the Authentication Providers API and Locale Id (localeId) is used in the System Locales API. If the request fails, it returns an error response.

Send Documentation Feedback - If you have comments about this documentation, you can contact the documentation team by sending your feedback to us. We appreciate your feedback!