Skip to content
Authrim

Get a guest account.

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

Returns a guest account, its browser resume credentials, and the latest upgrade summary when present. Non-guest users are rejected. Reads use the account storage and return no personal field values. Unavailable or ambiguous account storage fails the request with 503.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Guest account id.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Guest account detail response.

Media type application/json
object
user_id
required
string
user_type
required
string
Allowed values: end_user
registration_state
required
string
Allowed values: guest
created_at
required
integer format: int64
last_login_at
integer | null format: int64
resume_credentials
required
Array<object>
object
id
required
string
expires_at
required
integer | null format: int64
is_expired
required
boolean
created_at
required
integer format: int64
last_used_at
required
integer format: int64
is_active
required
boolean
key
additional properties
upgrade
required
One of:
object
id
string
guest_user_id
string
upgraded_user_id
required
string
method
required
string
provider_id
string | null
upgraded_at
required
integer format: int64
preserve_sub
required
boolean
data_migrated
boolean
key
additional properties
key
additional properties
Example 
{
  "user_type": "end_user",
  "registration_state": "guest"
}

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

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

503

Section titled “503 ”

Guest account storage is unavailable or account ownership is ambiguous.