Update a custom claim schema.

PUT

/api/admin/custom-claims/{id}

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/custom-claims/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "display_label": "Department Name", "include_in_userinfo": true, "is_searchable": true }'

Updates mutable custom claim schema fields. Field key and PII classification are intentionally immutable through this endpoint.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Custom claim schema identifier.

Request Body ^required

Media type application/json

object

>= 1 properties

display_label

string

<= 255 characters

field_type

string

Allowed values: string number boolean date json string_array number_array

is_required

boolean

is_active

boolean

include_in_id_token

boolean

include_in_userinfo

boolean

include_in_introspection

boolean

required_scopes

Array<string> | null

<= 50 items

key

additional properties

Example

{
  "display_label": "Department Name",
  "include_in_userinfo": true,
  "is_searchable": true
}

Responses

200

Custom claim schema mutation response.

Media type application/json

object

schema

required

object

id

required

string

tenant_id

required

string

field_key

required

string

display_label

required

string

field_type

required

string

Allowed values: string number boolean date json string_array number_array

is_pii

required

integer

Allowed values: 0 1

is_required

integer

Allowed values: 0 1

is_active

required

integer

Allowed values: 0 1

operation_status

string

Allowed values: active deleting renaming error

field_usage_bindings

Array<object>

object

key

additional properties

created_at

required

integer format: int64

updated_at

required

integer format: int64

key

additional properties

key

additional properties

Example

{
  "schema": {
    "field_type": "string",
    "is_pii": 0,
    "is_required": 0,
    "is_active": 0,
    "operation_status": "active"
  }
}

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

404

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

409

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