Skip to content
Authrim

Retry or reset a failed custom claim operation.

POST
/api/admin/custom-claims/{id}/retry
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/custom-claims/example/retry \
  --header 'Authorization: Bearer <token>'

Retries recovery for a schema in error operation state. Delete failures are reset to active for a manual retry; rename failures attempt to finish the stored rename or reset when details are invalid.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Custom claim schema identifier.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Custom claim failed-operation retry response.

Media type application/json
object
success
required
boolean
action
required
string
message
string
schema
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
affected_users
integer
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"
}

404

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

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