Get All Users

Gets a list of all users

continuationToken: Used for paging. Use the token provided in the paging object in the previous response to get the next page. Leave blank to get the first page.

URL

https://{{HOST}}/security/user?v={version}

Method

GET

Required IMS Scopes

  • securityapi_all

Versions Supported

  • 2.0 (Default)

URL Query Parameters

Name Description Example Type
v
optional
Version of the api to use /user?v=2.0 number

Request Header Parameters

Type Value Description
Authorization
required
Bearer {access_token} IMS access token

Example

Request

curl -X GET 
  'https://{{HOST}}/securityapi/user?v=2.0' 
  -H 'Authorization: Bearer {access_token}'

Response

[
  "data": [
  {
    "username": "~AAD:user1jci.com",
    "credentials": {
      "protectedPassword": null,
      "crypto": null
    },
    "identity": {
      "address": null,
      "email": "user1@jci.com",
      "extraClaims": null,
      "familyName": "Last",
      "givenName": "First",
      "name": "First Last",
      "organization": "jci.com",
      "phone": null,
      "website": null
    },
    "meta": {
      "created": "2017-01-30T19:49:07.0633624Z",
      "emailVerified": true,
      "enabled": true,
      "failedLoginCount": null,
      "failedPasswordResetCount": null,
      "lastFailedLogin": null,
      "lastFailedPasswordReset": null,
      "lastLogin": null,
      "lastUpdated": null,
      "phoneVerified": true,
      "provider": null,
      "providerId": null
    },
    "privilege": {
      "roles": null
    },
    "id": "~AAD:user1@jci.com",
    "subject": "53bd4fa1-e91c-4f53-afbe-05f3ec58148d"
  },
  ...]
  "paging": {
        "totalCount": 100,
        "continuationToken": "{"token":"+RID:zG4-ANhcfQH2AAAAAAAAAA==#RT:1#TRC:100#FPC:AgEAAAAQAPEAwP9BQB8A0QAA8GFDfwA=","range":{"min":"","max":"05C1B9CD673390"}}"
    }
]

Errors

Error Description
Error Name Description of Error

Response Body Parameters

Name Description Schema
Object Name Description object definition
data Description object definition
paging Description object definition