Get User By Id

Retrieves the details of a user specified by user ID.

GET /platform/adminuser/accounts/{userId}/userbyid

Error

A valid request URL is required to generate request examples

200

{
  "emailAddress": "<string>",
  "externalId": "<string>",
  "firstName": "<string>",
  "id": "<string>",
  "identityProviderId": "<string>",
  "isActive": true,
  "lastName": "<string>",
  "localeCode": "<string>",
  "optInToEmail": true,
  "optInToTextMessage": true,
  "password": "<string>",
  "phoneNumber": "<string>",
  "roles": [
    {
      "assignedInScope": {
        "id": 123,
        "name": "<string>",
        "type": "<string>"
      },
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "roleId": 123,
      "roleName": "<string>",
      "roleResources": [
        {
          "id": "<string>",
          "type": "<string>"
        }
      ],
      "roleTags": [
        "<string>"
      ],
      "userId": "<string>"
    }
  ],
  "systemData": {
    "createdOn": "2023-11-07T05:31:56Z",
    "failedLoginAttemptCount": 123,
    "firstFailedLoginAttemptOn": "2023-11-07T05:31:56Z",
    "isLocked": true,
    "isPasswordChangeRequired": true,
    "lastLockedOn": "2023-11-07T05:31:56Z",
    "lastLoginOn": "2023-11-07T05:31:56Z",
    "lastPasswordChangeOn": "2023-11-07T05:31:56Z",
    "remainingLoginAttempts": 123,
    "updatedOn": "2023-11-07T05:31:56Z"
  },
  "userName": "<string>"
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

userId · string · required

Unique identifier of the user whose details you want to view.

Query Parameters

responseGroups · string

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

emailAddress · string | null

externalId · string | null

firstName · string | null

id · string | null

identityProviderId · string | null

isActive · boolean

lastName · string | null

localeCode · string | null

optInToEmail · boolean | null

optInToTextMessage · boolean | null

password · string | null

phoneNumber · string | null

roles · object[] | null

Show child attributes

systemData · object

Show child attributes

userName · string | null