コンテンツにスキップ
Authrim

List custom claim schemas.

GET
/api/admin/custom-claims
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/custom-claims?page=1&limit=50&field_type=string&is_pii=0&is_active=0&is_system=0&operation_status=active' \
  --header 'Authorization: Bearer <token>'

Lists custom claim schema definitions with page-based pagination and filters for field type, PII state, active/system flags, and operation status.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
page
integer
default: 1 >= 1

One-based result page.

limit
integer
default: 50 >= 1 <= 100

Maximum number of schemas to return. The implementation caps this at 100.

search
string

Search term matched against field key, label, and description.

field_type
string
Allowed values: string number boolean date json string_array number_array

Filter by custom claim field type.

is_pii
string
Allowed values: 0 1

Filter by PII storage flag: 1 for PII fields, 0 for non-PII fields.

is_active
string
Allowed values: 0 1

Filter by active flag.

is_system
string
Allowed values: 0 1

Filter by system-defined flag.

operation_status
string
Allowed values: active deleting renaming error

Filter by current schema operation status.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Custom claim schema list response.

Media type application/json
object
schemas
required
Array<object>
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
pagination
required
object
page
required
integer
>= 1
limit
required
integer
>= 1
total
required
integer
total_pages
required
integer
key
additional properties
key
additional properties
Example 
{
  "schemas": [
    {
      "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"
}

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