Atlan API documentation

List users

GET /api/service/users

List all the users defined in Atlan.

Query parameters

limit integer(int32)

Maximum number of records to be returned.
offset integer(int32)

Starting point for records to return, for paging.
sort string

Property by which to sort the records.

Values are createdTimestamp, firstName, username, or email.
count boolean

Whether to return the total count of records or not. If set to false both totalRecord and filterRecord will return 0.

Default value is true.
filter object

Filter data by specifying filters based on RQL

Responses

• 200 object

List of users from Atlan.
- totalRecord integer(int32)
- filterRecord integer(int32)
- records array[object]
  
  Instance of a user in Atlan, with its detailed information.
  id string
  
  Unique identifier for the user.
  
  username string
  
  Unique username for the user.
  
  firstName string | null
  
  First name of the user.
  
  lastName string | null
  
  Surname of the user.
  
  email string
  
  Email address of the user.
  
  emailVerified boolean | null
  
  When true, the user's email has been verified.
  
  enabled boolean | null
  
  When true, the user is enabled and allowed to log in to Atlan. When false, the user will be prevented from logging in to Atlan.
  
  attributes object
  
  Attributes for users in Atlan.
  
  invitedAt array[string] | null
  
  Date and time at which the user was invited to Atlan.
  
  invitedBy array[string] | null
  
  Username of the user who invited this user.
  
  invitedByName array[string] | null
  
  Full name of the user who invited this user.
  
  designation array[string] | null
  
  groupCount integer
  
  Number of groups to which the user belongs.
  
  Default value is 0.
  
  decentralizedRoles array[object] | null
  
  Instance of a decentralized role in Atlan, with its detailed information.
  
  roleId string
  
  Unique identifier for the role.
  
  level string
  
  Value is connection.
  
  privilege string
  
  Value is admin.
  
  defaultRoles array[string]
  
  roles array[string]
  
  personas array[object]
  
  Reference to a persona in Atlan.
  
  id string
  
  Unique identifier for the persona.
  
  name string
  
  Name of the persona.
  
  displayName string | null
  
  Display name of the persona.
  
  purposes array[object]
  
  Reference to a purpose in Atlan.
  
  id string
  
  Unique identifier for the purpose.
  
  name string
  
  Name of the purpose.
  
  createdTimestamp integer(int64)
  
  Date and time (epoch) at which the user was created, in milliseconds.
  
  lastLoginTime integer(int64) | null
  
  Date and time (epoch) at which the user was created, in milliseconds.
  
  loginEvents array[object]
  
  Instance of a login event in Atlan, with its detailed information.
  
  clientId string
  
  details object
  
  ipAddress string
  
  realmId string
  
  sessionId string
  
  time integer(int64)
  
  Date and time (epoch) at which the event occurred, in milliseconds.
  
  type string
  
  Value is LOGIN.
  
  userId string
  
  Unique identifier of the user for whom the event occurred.
  
  adminEvents array[object]
  
  Instance of an admin event in Atlan, with its detailed information.
  
  authDetails object
  
  clientId string
  
  ipAddress string
  
  realmId string
  
  userId string
  
  Unique identifier of the user.
  
  operationType string
  
  Values are ACTION, CREATE, UPDATE, or DELETE.
  
  realmId string
  
  representation string | null
  
  resourcePath string
  
  resourceType string
  
  Values are REALM, REALM_ROLE, REALM_ROLE_MAPPING, USER, IDENTITY_PROVIDER, or IDENTITY_PROVIDER_MAPPER.
  
  time integer(int64)
  
  Date and time (epoch) at which the event occurred, in milliseconds.

GET /api/service/users

curl \
 -X GET https://tenant.atlan.com/api/service/users \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response example (200)

{
  "totalRecord": 3,
  "filterRecord": 3,
  "records": [
    {
      "id": "9cdc2c2e-6d60-448c-a083-0f4a295499ea",
      "username": "jsmith",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jsmith@example.com",
      "emailVerified": true,
      "enabled": true,
      "attributes": {
        "invitedAt": [
          "2022-02-23T21:51:43Z"
        ],
        "invitedBy": [
          "jsmith"
        ],
        "invitedByName": [
          "Jane Smith"
        ],
        "designation": [
          ""
        ]
      },
      "groupCount": 1,
      "decentralizedRoles": [
        {
          "roleId": "90af78ec-998f-4939-aa23-2159c7312b6e",
          "level": "connection",
          "privilege": "admin"
        }
      ],
      "defaultRoles": [
        "offline_access",
        "uma_authorization",
        "$guest"
      ],
      "roles": [
        "string"
      ],
      "personas": [
        {
          "id": "3f94d413-ae47-4ddb-a5a9-1b286e7eb04e",
          "name": "Base",
          "displayName": "Base"
        }
      ],
      "purposes": [
        {
          "id": "12846d83-d117-42e1-a0fd-823dfa75e876",
          "name": "Restricted Protection"
        }
      ],
      "createdTimestamp": 1645653103555,
      "lastLoginTime": 42,
      "loginEvents": [
        {
          "clientId": "atlan-frontend",
          "details": {},
          "ipAddress": "10.110.9.149",
          "realmId": "default",
          "sessionId": "ceb0cd29-fd3d-40ca-a3b2-a83c6e00cd5d",
          "time": 1651679584113,
          "type": "LOGIN",
          "userId": "53954c95-47f8-49b3-9812-23eb40fb07cc"
        }
      ],
      "adminEvents": [
        {
          "authDetails": {
            "clientId": "2a292d66-65b7-4293-a96d-42e6378e2dc0",
            "ipAddress": "10.100.0.185",
            "realmId": "default",
            "userId": "9cdc2c2e-6d60-448c-a083-0f4a295499ea"
          },
          "operationType": "CREATE",
          "realmId": "default",
          "representation": "string",
          "resourcePath": "users/ef8abf95-f3b9-475f-aef0-8477ed1a49f1/role-mappings/realm",
          "resourceType": "REALM_ROLE_MAPPING",
          "time": 1645653103555
        }
      ]
    }
  ]
}