Get domain hash key migration status

GET

/api/admin/settings/domain-hash-keys/status

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/settings/domain-hash-keys/status \
  --header 'Authorization: Bearer <token>'

Reports current key version, migration status, and user/organization mapping counts by hash key version.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Domain hash key migration status.

Media type application/json

object

current_version

integer

migration_in_progress

boolean

users_by_version

User counts keyed by hash key version.

object

key

additional properties

integer

org_mappings_by_version

Organization domain mapping counts keyed by hash key version.

object

key

additional properties

integer

deprecated_versions

Array<integer>

estimated_completion

string

message

string

key

additional properties

Example

{
  "current_version": 2,
  "migration_in_progress": true,
  "users_by_version": {
    "1": 12,
    "2": 48
  },
  "org_mappings_by_version": {
    "1": 3,
    "2": 24
  },
  "deprecated_versions": [
    1
  ],
  "estimated_completion": "2026-07-01T00:00:00.000Z"
}

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

500

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