Hanzo
OpenapiIam

Steps a platform operator into an organization: it returns their own access…

Steps a platform operator into an organization: it returns their own access token re-scoped to that tenant, so they see what the tenant sees.

POST /v1/iam/assume

Addresshttps://api.hanzo.ai/v1/iam/assume
MethodPOST
Operationpost_iam_assume
AuthAuthorization: Bearer $HANZO_API_KEY

Steps a platform operator into an organization: it returns their own access token re-scoped to that tenant, so they see what the tenant sees.

The token still names the operator — stepping in is not becoming somebody else — and records the organization it was scoped to, so everything done with it is attributed to the person who did it. Only a platform operator may, and the attempt is recorded whether or not it succeeds.

Request

3 fields, body application/json (required).

FieldInTypeRequiredDescription
Authorizationheaderstring
X-Forwarded-Forheaderstring
orgbodystring

Response

StatusBodyMeaning
200iam.Answerok
400iam.Answerbad request
401iam.Answerunauthorized
403iam.Answerforbidden
404iam.Answernot found

200 body — 8 fields.

FieldInTypeAlwaysDescription
codebodystring
databodyobject
data2bodyobject
data3bodyobject
msgbodystring
namebodystring
statusbodystring
subbodystring

Failure carries the platform error shape — see Errors.

Examples

hanzo iam assume

IAM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page