Skip to content
Authrim

Get custom claim statistics.

GET
/api/admin/custom-claims/stats
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/custom-claims/stats \
  --header 'Authorization: Bearer <token>'

Returns schema counts, active PII/non-PII split, user-data counts, top non-PII field usage, and error-state counts.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Custom claim statistics response.

Media type application/json
object
total
required
integer
active_non_pii
required
integer
active_pii
required
integer
non_pii_users_with_data
required
integer
pii_users_with_data
required
integer
pii_users_approximate
required
boolean
field_usage
required
Array<object>
object
field_name
required
string
count
required
integer
key
additional properties
error_count
required
integer
key
additional properties
Example generated
{
  "total": 1,
  "active_non_pii": 1,
  "active_pii": 1,
  "non_pii_users_with_data": 1,
  "pii_users_with_data": 1,
  "pii_users_approximate": true,
  "field_usage": [
    {
      "field_name": "example",
      "count": 1
    }
  ],
  "error_count": 1
}

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