List reserved custom claim names.

GET

/api/admin/custom-claims/reserved-names

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/custom-claims/reserved-names \
  --header 'Authorization: Bearer <token>'

Returns OIDC and Authrim-reserved claim names that cannot be used as custom claim field_key values.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Reserved custom claim names response.

Media type application/json

object

reserved_names

required

Array<string>

key

additional properties

Example ^generated

{
  "reserved_names": [
    "example"
  ]
}

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