Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Users V2

Get User

Use this API to retrieve details for a single user in your account.

get/api/access/v2/users/{userId}

Path parameters

userIdstring uuid required

The unique identifier of the user.

Response

User retrieved successfully

userIdstring uuid

The unique identifier of the user.

firstNamestring

The first name of the user, as it appears in their profile.

lastNamestring

The last name of the user, as it appears in their profile.

fullNamestring

The full name of the user, combining their first and last names.

emailstring email

The email address associated with the user's account.

emailConfirmedboolean

The indicator of whether the user's email address has been confirmed.

activeboolean

The indicator of whether the user account is currently active.

internalboolean

The indicator of whether the user is an internal user, meaning they are part of the organization.

externalIdstring

The external identifier for the user, which may be used to reference them in external systems.

expirationDateTimestring date-time

The date and time the user account will expire.

disabledDateTimestring date-time

The date and time the user account was disabled.

createdDatestring date-time

The date and time the user account was created.

lastModifiedDatestring date-time

The date and time the user account was last modified.

lastLoginDatestring date-time

The date and time the user last logged in.

disabledBystring

The name of the user who disabled the current user.

defaultOrganizationNamestring

The name of the default organization for the user.

defaultOrganizationIdstring uuid

The unique identifier of the user's default organization.

Example response

{
  "userId": "423e4567-e89b-12d3-a456-426614174000",
  "firstName": "Ross",
  "lastName": "Taylor",
  "fullName": "Ross Taylor",
  "email": "jane.doe@example.com",
  "accessLevels": [
    {
      "organizationId": "423e4567-e89b-12d3-a456-426614174000",
      "organizationName": "My Org",
      "roleId": "423e4567-e89b-12d3-a456-426614174001",
      "roleName": "Audit Manager"
    }
  ],
  "emailConfirmed": true,
  "active": true,
  "externalId": "ext-123456",
  "expirationDateTime": "2025-01-01T12:00:00Z",
  "disabledDateTime": "2024-06-15T08:30:00Z",
  "createdDate": "2023-10-01T09:15:00Z",
  "lastModifiedDate": "2024-02-20T14:45:00Z",
  "lastLoginDate": "2024-09-10T07:05:00Z",
  "disabledBy": "Michael Douglas",
  "defaultOrganizationName": "My Org",
  "defaultOrganizationId": "423e4567-e89b-12d3-a456-426614174111"
}