Complete domain hash key rotation

PUT

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

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/settings/domain-hash-keys/complete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "deprecate_versions": [ 1 ] }'

Marks migration complete and deprecates requested old key versions while keeping the current version active.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

deprecate_versions

Array<integer>

key

additional properties

Example

{
  "deprecate_versions": [
    1
  ]
}

Responses

200

Domain hash key rotation completed.

Media type application/json

object

message

string

current_version

integer

deprecated_versions

Array<integer>

key

additional properties

Example

{
  "message": "Key rotation completed",
  "current_version": 2,
  "deprecated_versions": [
    1
  ]
}

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