User authentication information

GET /users/auth

Provides authentication information about a user, including elevated permission status and TOTP device availability.

Responses

200

User authentication information response
Hide response attributes Show response attributes object
- has_totp_device boolean
  
  Deprecated: True if the user has an available TOTP device
- totp_device_source string
  
  Deprecated: The TOTP device source
- has_elevated_permissions boolean Required
  
  Deprecated: True if the user has elevated permissions
- elevated_permissions_expire_at string(date-time)
  
  Deprecated: The UTC time when elevated permissions will expire, if the user has elevated permissions
- totp_device_source_enable_mfa_href string
  
  Deprecated: URL for configuring an MFA TOTP device. Does not apply when totp_device_source is 'native'.
- refresh_token_url string Required
  
  The API to be used when refreshing the current user's JWT
- expires_at string(date-time)
  
  The UTC time when current authentication will expire. Applies to only token based authentication

GET /users/auth

curl \
 -X GET https://{{hostname}}/api/v1/users/auth

Response examples (200)

{
  "has_totp_device": true,
  "totp_device_source": "string",
  "has_elevated_permissions": true,
  "elevated_permissions_expire_at": "2024-05-04T09:42:00+00:00",
  "totp_device_source_enable_mfa_href": "string",
  "refresh_token_url": "string",
  "expires_at": "2024-05-04T09:42:00+00:00"
}