Skip to content
Authrim

List custom claim schema history.

GET
/api/admin/custom-claims/{schemaId}/history
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/custom-claims/example/history?limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

Lists recorded custom claim schema versions in descending version order with operation metadata and a summary of changed fields.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
schemaId
required
string

Custom claim schema identifier.

Query Parameters

Section titled “Query Parameters ”
limit
integer
default: 50 >= 1 <= 100

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

offset
integer
0

Zero-based offset into the history list.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Custom claim history list response.

Media type application/json
object
versions
required
Array<object>
object
version
required
integer
>= 1
operation
required
string
Allowed values: create update delete rename activate deactivate
created_at
required
integer format: int64
actor_id
string | null
actor_type
string | null
change_source
string | null
changes_summary
required
object
added
required
integer
removed
required
integer
modified
required
integer
key
additional properties
key
additional properties
total
required
integer
key
additional properties
Example 
{
  "versions": [
    {
      "version": 3,
      "operation": "rename",
      "created_at": 1770000000,
      "actor_id": "admin_123",
      "actor_type": "admin",
      "change_source": "admin_api",
      "changes_summary": {
        "added": 0,
        "removed": 0,
        "modified": 1
      }
    }
  ],
  "total": 3
}

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