Skip to content
Authrim

List guest accounts.

GET
/api/admin/guest-users
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/guest-users?limit=50&offset=0&include_expired=false' \
  --header 'Authorization: Bearer <token>'

Lists browser guest accounts for the current tenant, excluding accounts without an active resume credential unless requested. Routed storage uses cursor pagination; offset must be zero. Results are ordered by last use descending, then user id and shard order. Continuations expire after 15 minutes and are invalidated by changes to the query or account storage inventory. Any unavailable account shard fails the request with 503; partial results are never returned.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit
integer
default: 50 >= 1 <= 100

Maximum users to return, clamped to 100.

offset
integer
0

Pagination offset for direct storage only; routed storage requires zero.

include_expired
boolean

Include expired or inactive browser resume credentials.

cursor
string

Opaque next_cursor from the previous page; bound to this tenant and query.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Guest account list response.

Media type application/json
object
total
required
integer
limit
required
integer
>= 1
offset
required
integer
next_cursor

Routed storage continuation, or null when complete; absent for direct offset pagination.

string | null
users
required
Array<object>
object
user_id
required
string
credential_count
required
integer
active_credential_count
required
integer
next_credential_expiry
required
integer | null format: int64
has_active_resume_credential
required
boolean
created_at
required
integer format: int64
last_used_at
required
integer format: int64
key
additional properties
key
additional properties
Example generated
{
  "total": 1,
  "limit": 1,
  "offset": 1,
  "next_cursor": "example",
  "users": [
    {
      "user_id": "example",
      "credential_count": 1,
      "active_credential_count": 1,
      "next_credential_expiry": 1,
      "has_active_resume_credential": true,
      "created_at": 1,
      "last_used_at": 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"
}

409

Section titled “409 ”

Guest read cursor is invalid, expired, or no longer matches the query or storage inventory.

503

Section titled “503 ”

Guest account storage or continuation storage is unavailable.