Return anonymous-user upgrade eligibility and history.

GET

/api/auth/upgrade/status

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/auth/upgrade/status

Responses

200

Successful JSON response.

Media type application/json

object

user_id

required

string

is_anonymous

required

boolean

upgrade_eligible

required

boolean

profile_completion_required

required

boolean

missing_required_custom_claims

required

Array<object>

object

field_key

string

label

string

field_type

string

account_lifecycle_state

required

string

upgrade_history

required

Array<object>

object

id

string

method

string

upgraded_at

integer

preserve_sub

boolean

Example

{
  "user_id": "user_123",
  "is_anonymous": false,
  "upgrade_eligible": false,
  "profile_completion_required": false,
  "missing_required_custom_claims": [],
  "account_lifecycle_state": "active",
  "upgrade_history": [
    {
      "id": "upgrade_123",
      "method": "email",
      "upgraded_at": 1770000000000,
      "preserve_sub": true
    }
  ]
}