List guest account upgrades.

GET

/api/admin/guest-users/{id}/upgrades

Code sample: Shell / cURL

curl --request GET \
  --url 'https://auth.example.com/api/admin/guest-users/example/upgrades?limit=50' \
  --header 'Authorization: Bearer <token>'

Returns upgrade-history records where the supplied user id was either the guest source user or upgraded target user, including history whose source account has been deleted. Pages are ordered by upgrade time descending, then record id and shard order. Continuations expire after 15 minutes and are bound to the tenant, requested user, and account storage inventory. Any unavailable account shard fails the request with 503.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Guest or upgraded user id.

Query Parameters

limit

integer

default: 50 >= 1 <= 100

Maximum upgrade records to return, clamped to 100.

cursor

string

Opaque next_cursor from the previous page for this user.

Responses

200

Guest account upgrade history response.

Media type application/json

object

user_id

required

string

next_cursor

required

Continuation for this user, or null when complete.

string | null

upgrades

required

Array<object>

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 ^generated

{
  "user_id": "example",
  "next_cursor": "example",
  "upgrades": [
    {
      "id": "example",
      "guest_user_id": "example",
      "upgraded_user_id": "example",
      "method": "example",
      "provider_id": "example",
      "upgraded_at": 1,
      "preserve_sub": true,
      "data_migrated": true
    }
  ]
}

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

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

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

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

503

Guest account storage or continuation storage is unavailable.