Record a key access event.

POST

/api/admin/field-mapping/key-registries/{keyRegistryId}/access-events

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/key-registries/example/access-events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "accessType": "persistent_identifier.preview", "outcome": "success" }'

Records access telemetry for the selected key registry and optional key version. The route stores the event through the idempotent field-mapping mutation layer and returns { result: { keyRegistryId, recorded } }.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

keyRegistryId

required

string

Header Parameters

Idempotency-Key

string

Idempotency key for state-changing operations that support replay protection.

Request Body ^required

Media type application/json

object

keyVersionId

string | null

actorId

string | null

accessType

required

string

outcome

required

string

key

additional properties

Example

{
  "accessType": "persistent_identifier.preview",
  "outcome": "success"
}

Responses

200

Key access record response.

Media type application/json

object

result

required

object

keyRegistryId

required

string

recorded

required

boolean

key

additional properties

key

additional properties

Example ^generated

{
  "result": {
    "keyRegistryId": "example",
    "recorded": 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"
}

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

409

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