Delete deprecated domain hash key version

DELETE

/api/admin/settings/domain-hash-keys/{version}

Code sample: Shell / cURL

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

Deletes a deprecated domain hash key version only after it is no longer current, marked deprecated, and unused by users.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

version

required

integer

>= 1

Deprecated domain hash key version.

Responses

200

Deprecated domain hash key version deleted.

Media type application/json

object

message

string

remaining_versions

Array<integer>

key

additional properties

Example

{
  "message": "Version 1 deleted",
  "remaining_versions": [
    2
  ]
}

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