Skip to content

Grant a shell role to a user

POST
/api/users/{user_id}/roles

Create a shell role grant for user_id in org.

Errors

404 — user is not a member of this organization. 409 — user already holds this role (active grant exists). 422 — unknown role string.

Authorizations

Parameters

Path Parameters

user_id
required
string format: uuid

Query Parameters

organization_id
required
string format: uuid

Request Body required

Request body for creating a role grant.

object
role
required
string

Responses

201

Successful Response

Response schema for a single role grant.

sod_warning is populated when granting ELEVATED or BREAKGLASS to a user who already holds an org-tenancy OWNER or ADMIN role — a separation-of-duties concern. None (omitted) when no SoD concern exists. This is a warning only; it does NOT block the grant.

object
created_at
required
string format: date-time
granted_by_id
required
Any of:
string format: uuid
id
required
string format: uuid
organization_id
required
string format: uuid
role
required
string
sod_warning
Any of:
string
user_id
required
string format: uuid

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string