List custom claim presets.

GET

/api/admin/custom-claims/presets

Code sample: Shell / cURL

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

Returns built-in custom claim presets and the field keys that already exist for the tenant so a UI can show which preset fields are already applied.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Custom claim preset list response.

Media type application/json

object

presets

required

Array<object>

object

id

required

string

name

required

string

description

string

fields

required

Array<object>

object

field_key

required

string

display_label

required

string

field_type

required

string

Allowed values: string number boolean date json string_array number_array

key

additional properties

key

additional properties

existing_field_keys

required

Array<string>

key

additional properties

Example

{
  "presets": [
    {
      "fields": [
        {
          "field_type": "string"
        }
      ]
    }
  ]
}

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