Skip to main content
PUT
Assign to an account

Authorizations

Authorization
string
header
required

OAuth 2.0 client-credentials flow. Request an access token from the token endpoint and send it as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

Unique key for this request, generated by the caller. Resending the same request with the same key returns the job the first one created instead of submitting a second one; sending a different request with a key already used is refused with 409, so a key accidentally reused across targets cannot silently skip them. Use one key per request, not one per batch. Recommended on every write: these operations change systems outside Oleria, so a client that times out and retries without one can apply the change twice. This matters even for the operations that are safe to repeat: asserting a membership that already exists grants nothing a second time, but without a key it is still a second job, with its own audit record and its own results.

Path Parameters

id
string
required

Global id of the role.

accountId
string
required

Global id of the account to act on.

Response

The change was accepted and is being applied. Poll the returned job for its outcome.

A reference to the job applying an accepted change.

jobId
string<uuid>
required

Id of the job applying this change.

Example:

"9f2b1c7e-5a84-4d6b-9c31-0e7f8a2d4b16"

self
string
required

Path of the job, the same value as the Location header.

Example:

"/v1/action-jobs/9f2b1c7e-5a84-4d6b-9c31-0e7f8a2d4b16"