Delete a custom claim schema.

DELETE

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

Code sample: Shell / cURL

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

Deletes an inactive custom claim schema after checking system-field and in-use constraints, then removes associated stored claim data.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Custom claim schema identifier.

Responses

200

Custom claim schema delete response.

Media type application/json

object

success

required

boolean

deleted_id

required

string

key

additional properties

Example ^generated

{
  "success": true,
  "deleted_id": "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"
}

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