Skip to content
Authrim

Search users through the Agent-safe masked projection.

GET
/api/admin/agent-read/users
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/agent-read/users?page=1&limit=20&lifecycle_state=active' \
  --header 'Authorization: Bearer <token>'

Owner operation used by the fixed search_users tool. Requires admin:users:read, accepts only the documented filters, limits pages to 50, and never returns unmasked PII.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
page
integer
default: 1 >= 1
limit
integer
default: 20 >= 1 <= 50
search
string
<= 200 characters
verified
boolean
lifecycle_state
string
Allowed values: active deactivated deleted

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Masked user page.

Media type application/json
object
users
required
Array<object>
<= 50 items
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
next_cursor
required
string | null
total
required
integer
Example generated
{
  "users": [
    {
      "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
    }
  ],
  "next_cursor": "example",
  "total": 1
}

400

Section titled “400 ”

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

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