Skip to main content
PATCH
Update a role granted to a user

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

If-Match
string | null

The grant's current ETag, required to guard against a concurrent update.

x-tenant-id
string
required

The organization ID the request is scoped to.

Path Parameters

email
string
required
role_id
string
required

Body

application/json
role
enum<string> | null

New role for the user. Omit to leave unchanged.

Available options:
admin,
editor,
monitor_editor,
viewer,
team_creator

Response

Successful Response

A role a user holds, with the scope it applies to.

A user holds a role in one of three ways: granted to them directly, inherited from a team they belong to, or applied to everyone in the organization by default. Only a direct grant can be changed — the other two are edited at their source.

id
string
required
read-only

The unique identifier of this role grant.

role
enum<string>
required

The role the user holds.

Available options:
admin,
editor,
monitor_editor,
viewer,
team_creator
entity
PermissionEntityWithDisplayName · object
required
read-only

The resolved scope this grant applies to — its type, id and human readable display name. Falls back to the organization when the grant carries no narrower scope.

is_default
boolean
required
read-only

Whether this role applies to everyone in the organization by default rather than being granted to this user.

granted_from_team_name
string | null
required

The team this role is inherited from, when the user holds it through team membership rather than directly.

create_time
string
required
read-only

When the role was granted — RFC 3339 UTC, e.g. 2026-06-05T10:30:00Z.

update_time
string
required
read-only

When the grant was last updated — RFC 3339 UTC.

etag
string
required
read-only

Opaque strong ETag for optimistic concurrency.

snowflake_organization_name
string | null

Snowflake organization this grant is scoped to, if any.

snowflake_account_uuid
string | null

Snowflake account this grant is scoped to, if any.

usage_group_id
string | null

Usage group this grant is scoped to, if any.