v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Governance

Upsert an actor mapping

Use this endpoint to create or update an actor mapping. Actor mappings associate system actor identifiers with human-readable display names and email addresses for audit log readability.

put/v1/governance/actor-mappings/{actorId}

Path parameters

actorIdstring required

The actor identifier to map.

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

X-Idempotency-Keystring

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Request body

displayNamestring

Human-readable display name for the actor

emailstring email

Email address associated with the actor

Example request

{
  "displayName": "John Doe",
  "email": "john.doe@company.com"
}

Response

Actor mapping created or updated.

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

actorIdstring

The actor identifier

displayNamestring

Human-readable display name

emailstring

Email address

createdAtstring date-time

Timestamp when the mapping was created

updatedAtstring date-time

Timestamp when the mapping was last updated

Example response

{
  "actorId": "user-abc-123",
  "displayName": "John Doe",
  "email": "john.doe@company.com"
}