Skip to main content
POST
Assign account role
Requires the IAM action workspace:AssignAccountRole. See WORKSPACE permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Path Parameters

account_id
string<uuid>
required

Body

application/json
principal_type
enum<string>
required
Available options:
user,
group
principal_id
string<uuid>
required

Immutable UUID of a user or users-only group in this organization.

role_id
string<uuid>
required

Immutable UUID of a role owned by the target account.

Response

Account role assigned

role_assignment
object