Detect required custom claim violations.

POST

/api/admin/custom-claims/required-violations/detect

Code sample: Shell / cURL

curl --request POST \
  --url 'https://auth.example.com/api/admin/custom-claims/required-violations/detect?limit=20' \
  --header 'Authorization: Bearer <token>'

Scans users for missing required custom claim values and returns a bounded preview of violating users.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Query Parameters

limit

integer

default: 20 >= 1 <= 100

Maximum number of violations to include in the preview. The implementation caps this at 100.

Responses

200

Required custom claim violation detection response.

Media type application/json

object

summary

required

object

scanned_users

required

integer

violating_users

required

integer

required_schema_count

required

integer

preview_limit

required

integer

key

additional properties

violations

required

Array<object>

object

key

additional properties

truncated

required

boolean

key

additional properties

Example ^generated

{
  "summary": {
    "scanned_users": 1,
    "violating_users": 1,
    "required_schema_count": 1,
    "preview_limit": 1
  },
  "violations": [
    {
      "additionalProperty": "example"
    }
  ],
  "truncated": true
}

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

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