Skip to content
Authrim

Create a custom claim schema.

POST
/api/admin/custom-claims
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/custom-claims \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "field_key": "department", "display_label": "Department", "field_type": "string", "is_pii": false, "include_in_id_token": true, "include_in_userinfo": true, "required_scopes": [ "profile" ] }'

Creates a non-system custom claim schema. Reserved OIDC claim names and duplicate active field keys are rejected. PII fields use the configured PII storage source.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
field_key
required
string
/^[a-z][a-z0-9_]{0,63}$/
display_label
required
string
<= 255 characters
field_type
string
Allowed values: string number boolean date json string_array number_array
is_pii
boolean
required_scopes
Array<string>
<= 50 items
key
additional properties
Example 
{
  "field_key": "department",
  "display_label": "Department",
  "field_type": "string",
  "is_pii": false,
  "include_in_id_token": true,
  "include_in_userinfo": true,
  "required_scopes": [
    "profile"
  ]
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

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

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

409

Section titled “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

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