コンテンツにスキップ
Authrim

Get one user through the Agent-safe masked projection.

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

Requires admin:users:read; credential identifiers and custom-field values are omitted.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string
>= 1 characters <= 128 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Masked user and non-sensitive factor counts.

Media type application/json
object
user
required
object
id
required
string
tenant_id
required
string | null
email_masked
required
string | null
name_masked
required
string | null
email_verified
boolean
phone_number_verified
boolean
user_type
string | null
status
string | null
lifecycle_state
string | null
created_at
integer | null format: int64
updated_at
integer | null format: int64
last_login_at
integer | null format: int64
key
additional properties
authentication_factors
required
object
passkey_count
required
integer
totp_count
required
integer
key
additional properties
missing_required_fields
required
Array<object>
object
Example generated
{
  "user": {
    "id": "example",
    "tenant_id": "example",
    "email_masked": "example",
    "name_masked": "example",
    "email_verified": true,
    "phone_number_verified": true,
    "user_type": "example",
    "status": "example",
    "lifecycle_state": "example",
    "created_at": 1,
    "updated_at": 1,
    "last_login_at": 1
  },
  "authentication_factors": {
    "passkey_count": 1,
    "totp_count": 1
  },
  "missing_required_fields": [
    {}
  ]
}

401

Section titled “401 ”

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"
}

403

Section titled “403 ”

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"
}

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"
}