Skip to content
Authrim

Apply a custom claim preset.

POST
/api/admin/custom-claims/presets/apply
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/custom-claims/presets/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "preset_id": "profile-basic", "field_keys": [ "given_name", "family_name" ] }'

Creates selected fields from a built-in custom claim preset. Existing field keys are skipped and the response reports created and skipped keys.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
preset_id
required
string
field_keys
Array<string>
key
additional properties
Example 
{
  "preset_id": "profile-basic",
  "field_keys": [
    "given_name",
    "family_name"
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Custom claim preset apply response.

Media type application/json
object
preset_id
required
string
created_count
required
integer
skipped_count
required
integer
created_field_keys
required
Array<string>
skipped_field_keys
required
Array<string>
key
additional properties
Example generated
{
  "preset_id": "example",
  "created_count": 1,
  "skipped_count": 1,
  "created_field_keys": [
    "example"
  ],
  "skipped_field_keys": [
    "example"
  ]
}

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