コンテンツにスキップ
Authrim

Get an end user.

GET
/api/admin/users/{id}
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/users/example \
  --header 'Authorization: Bearer <token>'

Get User in the Users area. Use this operation to retrieve user data without mutating tenant state.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Header Parameters

Section titled “Header Parameters ”
X-Tenant-Id
string

Tenant selector for multi-tenant admin requests.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Admin end-user detail response.

Media type application/json
object
user
required
One of:
object
id
required
string
tenant_id
required
string
email
required
string | null format: email
name
required
string | null
given_name
required
string | null
family_name
required
string | null
nickname
required
string | null
preferred_username
required
string | null
picture
required
string | null format: uri
email_verified
required
boolean
phone_number
required
string | null
website
required
string | null
gender
required
string | null
birthdate
required
string | null
locale
required
string | null
zoneinfo
required
string | null
address_formatted
required
string | null
address_street_address
required
string | null
address_locality
required
string | null
address_region
required
string | null
address_postal_code
required
string | null
address_country
required
string | null
declared_residence
required
string | null
pii_class
required
string
Allowed values: PROFILE
phone_number_verified
required
boolean
user_type
required
string
is_active
required
boolean
pii_partition
required
string
pii_status
required
string
Allowed values: active deleted
lifecycle_state
required
string
created_at
required

Unix timestamp in milliseconds.

integer | null format: int64
updated_at
required

Unix timestamp in milliseconds.

integer | null format: int64
last_login_at
required
integer | null format: int64
status
required
string
Allowed values: active inactive
suspended_at
required
integer | null format: int64
suspended_until
required
integer | null format: int64
locked_at
required
integer | null format: int64
locked_until
required
integer | null format: int64
key
additional properties
passkeys
Array<object>
object
id
string
credential_id
string
device_name
string | null
aaguid

Display-only WebAuthn authenticator AAGUID. Do not use for trust decisions.

string | null
provider
One of:
object
aaguid
required
string
name
required
string | null
icon_dark
required

Display-only data URI icon for dark backgrounds when available.

string | null
icon_light
required

Display-only data URI icon for light backgrounds when available.

string | null
known
required
boolean
created_at
One of:
integer
last_used_at
One of:
integer
key
additional properties
totp_credentials
Array<object>
object
id
required
string
label
required
string
algorithm
required
string
Allowed values: SHA1 SHA256 SHA512
digits
required
integer
Allowed values: 6 8
period
required
integer
window
required
integer
status
required
string
Allowed values: pending active disabled
created_at
required
integer | null format: int64
activated_at
required
integer | null format: int64
last_used_at
required
integer | null format: int64
key
additional properties
missing_required_fields
Array<object>
object
key
additional properties
customFields
Array<object>
object
key
additional properties
Example 
{
  "user": {
    "id": "user_123",
    "tenant_id": "default",
    "email": "[email protected]",
    "name": "Example User",
    "given_name": "Example",
    "family_name": "User",
    "nickname": null,
    "preferred_username": "example",
    "picture": "https://auth.example.com/avatars/user_123.png",
    "phone_number": null,
    "website": null,
    "gender": null,
    "birthdate": null,
    "locale": "en-US",
    "zoneinfo": "UTC",
    "address_formatted": null,
    "address_street_address": null,
    "address_locality": null,
    "address_region": null,
    "address_postal_code": null,
    "address_country": null,
    "declared_residence": null,
    "pii_class": "PROFILE",
    "email_verified": true,
    "phone_number_verified": false,
    "user_type": "end_user",
    "is_active": true,
    "pii_partition": "default",
    "pii_status": "active",
    "created_at": 1770000000000,
    "updated_at": 1770003600000,
    "last_login_at": null,
    "status": "active",
    "suspended_at": null,
    "suspended_until": null,
    "locked_at": null,
    "locked_until": null,
    "lifecycle_state": "active"
  },
  "totp_credentials": [
    {
      "algorithm": "SHA1",
      "digits": 6,
      "status": "pending"
    }
  ]
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}