Skip to content
Authrim

Get domain hash key configuration

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

Returns email domain hash key metadata with secrets masked. If no key exists, the response reports source none and includes an explanatory message.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Domain hash key configuration with secrets masked.

Media type application/json
object
current_version
integer
secrets

Masked secrets keyed by version.

object
key
additional properties
string
migration_in_progress
boolean
deprecated_versions
Array<integer>
version
string
source
string
message
string
key
additional properties
Example 
{
  "current_version": 2,
  "secrets": {
    "1": "ab**************yz",
    "2": "cd**************wx"
  },
  "migration_in_progress": true,
  "deprecated_versions": [
    1
  ],
  "version": "1770000000000",
  "source": "kv"
}

400

Section titled “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

Section titled “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

Section titled “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

Section titled “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"
}