Skip to content

governance module route (requires governance:nhi:admin)

POST
/v1/m/governance/nhi/{ref}/offboard/finalize
curl --request POST \
--url https://example.com/v1/m/governance/nhi/example/offboard/finalize \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "reason": "example", "target_ref": "example" }'

Finalizes the offboarding of one non-human identity.

ref
required
string

Path parameter ref.

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Media type application/json
Any of:
object
reason
Any of:

Optional approval justification; a handler-specific default is used when empty.

string
target_ref
Any of:

Optional rotation target. The shared strict DTO also accepts it on offboard/finalize, where it is ignored.

string
Example generated
{
"reason": "example",
"target_ref": "example"
}

OK

Media type application/json
object
Example generated
{}

Bad request

Media type application/json
object
Example generated
{}

Unauthenticated

Media type application/json
object
Example generated
{}

Forbidden

Media type application/json
object
Example generated
{}

Not found

Media type application/json
object
Example generated
{}

Conflict / setup required

Media type application/json
object
Example generated
{}

Rate limited

Media type application/json
object
Example generated
{}