Fetch all users

GET /users

Fetches all available users.

Query parameters

  • include_disabled boolean

    True if disabled users should be included in the response

    Default value is false.

Responses

  • 200

    Users successfully fetched

    Hide response attribute Show response attribute object
    • users array[object] Required

      A list of users

      Hide users attributes Show users attributes object
      • user_name string Required

        The user's identifier

      • security object Required

        The user's security information

        Additional properties are allowed.

        Hide security attributes Show security attributes object
        • roles array[string]

          The set of roles assigned to a user

        • permissions array[string]

          The distinct set of permissions allowed by the user's roles. These correspond to operationId values in the OpenAPI definition.

        • elevated_permissions object

          The user's elevated permission status

          Additional properties are allowed.

          Hide elevated_permissions attributes Show elevated_permissions attributes object
          • enabled boolean Required

            True if the user has elevated permissions

          • expires_at string(date-time)

            The time at which the user's elevated permissions expire

        • password string

          The user's password. Only used when modifying a user.

        • enabled boolean

          True if the user is enabled

        • security_realm object

          The user's security realm

          Additional properties are allowed.

          Hide security_realm attributes Show security_realm attributes object
          • type string Required

            The type of the security realm

            Values are native, ldap, saml, or active_directory.

          • id string Required

            The identifier for the security realm

      • metadata object

        The users metadata

        Additional properties are allowed.

        Hide metadata attributes Show metadata attributes object
        • created_by string

          The Id of the user that created this user

        • created_at string(date-time)

          The date and time when the user was created

        • updated_by string

          The Id of the user that last updated this user

        • updated_at string(date-time)

          The date and time when the user was last updated

        • first_login_at string(date-time)

          The date and time when the user first logged in

        • last_login_at string(date-time)

          The date and time when the user last logged in

      • full_name string

        The user's optional full name

      • email string

        The user's optional email address

      • builtin boolean

        True if the user is a built-in read-only user
GET /users 
curl \
 -X GET https://{{hostname}}/api/v1/users
Response examples (200) 
{
  "users": [
    {
      "user_name": "string",
      "security": {
        "roles": [
          "string"
        ],
        "permissions": [
          "string"
        ],
        "elevated_permissions": {
          "enabled": true,
          "expires_at": "2024-05-04T09:42:00+00:00"
        },
        "password": "string",
        "enabled": true,
        "security_realm": {
          "type": "native",
          "id": "string"
        }
      },
      "metadata": {
        "created_by": "string",
        "created_at": "2024-05-04T09:42:00+00:00",
        "updated_by": "string",
        "updated_at": "2024-05-04T09:42:00+00:00",
        "first_login_at": "2024-05-04T09:42:00+00:00",
        "last_login_at": "2024-05-04T09:42:00+00:00"
      },
      "full_name": "string",
      "email": "string",
      "builtin": true
    }
  ]
}