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}

Upsert an actor mapping

cURL

curl --request PUT \
  --url https://matcher.sandbox.lerian.net/v1/governance/actor-mappings/{actorId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "John Doe",
  "email": "[e-mail]"
}
'

200

Example

{
  "actorId": "user:550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2026-01-15T10:30:00Z",
  "updatedAt": "2026-01-15T10:30:00Z",
  "displayName": "John Doe",
  "email": "[e-mail]"
}

Autorizaciones

Authorization · string · header · requerido

Bearer token authentication (format: "Bearer {token}")

Encabezados

X-Request-Id · string

A unique identifier for tracing the request across services.

X-Idempotency · string

Optional idempotency key for safe retries. Matcher reads the key only from this header, and only when you send one. A request that carries a key only in X-Idempotency-Key or Idempotency-Key is refused with 400 (MTCH-0015), and nothing is processed. If the same key is sent again and the original request was already processed, the stored response is returned with X-Idempotency-Replayed: true. A malformed key returns 400, a key whose first request is still in progress returns 409 (MTCH-0018), a key whose earlier attempt already ran but whose answer cannot be replayed returns 409 (MTCH-0022), and an idempotency storage failure returns 500. POST, PUT, PATCH and DELETE requests accept the header. These refusals are problem documents.

Parámetros de ruta

actorId · string · requerido

The actor identifier to map. Actor ID

Cuerpo

application/json

Actor mapping payload

displayName · string | null

Human-readable display name for the actor; optional, but at least one of displayName or email must be provided

Ejemplo:

"John Doe"

email · string<email> | null

Email address of the actor; optional, but at least one of displayName or email must be provided

Ejemplo:

"[e-mail]"

Respuesta

200

application/json

Actor mapping created or updated.

actorId · string · requerido

Opaque actor identifier the PII mapping is keyed on

Ejemplo:

"user:550e8400-e29b-41d4-a716-446655440000"

createdAt · string · requerido

Timestamp when the mapping was created, in RFC 3339 format (UTC)

Ejemplo:

"2026-01-15T10:30:00Z"

updatedAt · string · requerido

Timestamp when the mapping was last updated, in RFC 3339 format (UTC)

Ejemplo:

"2026-01-15T10:30:00Z"

displayName · string

Human-readable display name for the actor; absent when not set or after pseudonymization

Ejemplo:

"John Doe"

email · string

Email address of the actor; absent when not set or after pseudonymization

Ejemplo:

"[e-mail]"