Skip to main content
POST
Grant a role to an SSO group

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Path Parameters

sso_group_id
string
required

Body

application/json
role
enum<string>
required

The role to grant the group's members.

Available options:
admin,
editor,
monitor_editor,
viewer,
team_creator
scope
RoleGrantScope · object | null

The resource the role applies to. Omit to grant it across the whole organization.

Response

Successful Response

A role granted to an SSO group, with the scope it applies to.

id
string
required
read-only

The unique identifier of this role grant.

role
enum<string>
required

The role granted to the group's members.

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.

create_time
string
required
read-only

When the role was granted to the group — RFC 3339 UTC.

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.