Rename a custom claim field key.

PATCH

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

Code sample: Shell / cURL

curl --request PATCH \
  --url https://auth.example.com/api/admin/custom-claims/example/rename \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "new_field_key": "department_name" }'

Renames a custom claim schema field_key using a two-phase operation that migrates stored user data before committing the new key. System schemas, reserved names, conflicts, and concurrent operations are rejected.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Custom claim schema identifier.

Request Body ^required

Media type application/json

object

new_field_key

required

string

/^[a-z][a-z0-9_]{0,63}$/

key

additional properties

Example

{
  "new_field_key": "department_name"
}

Responses

200

Custom claim schema rename 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

affected_users

required

integer

old_key

required

string

new_key

required

string

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