Roles

List user role assignments

client.Zones.Users.Roles.List(ctx, userID, params) (*ZoneUserRoleListResponse, error)

GET/zones/{zoneId}/users/{userId}/roles

Assign role to user

client.Zones.Users.Roles.Assign(ctx, userID, params) (*RoleAssignment, error)

POST/zones/{zoneId}/users/{userId}/roles

Revoke role from user

client.Zones.Users.Roles.Revoke(ctx, roleID, params) error

DELETE/zones/{zoneId}/users/{userId}/roles/{roleId}

ModelsExpand Collapse

type RoleAssignment struct{…}

Represents a role assigned to a principal within a zone

ID string

Unique identifier of the role assignment

CreatedAt Time

Entity creation timestamp

formatdate-time

PrincipalID string

ID of the principal the role is assigned to (a user, application, or group ID).

PrincipalType string

The kind of principal the role is assigned to: user, application, or group. A role assigned to a group is inherited by that group's members.

RoleID string

ID of the assigned role

RoleIdentifier string

Role identifier: a lowercase slug (letters and digits separated by single hyphens or underscores), unique per owner type within a zone. Role identifiers surface in policy evaluation, so the slug restriction keeps them unambiguous in policy text.

minLength1

maxLength255

RoleOwnerType RoleAssignmentRoleOwnerType

Owner type of the assigned role. Disambiguates roles that share an identifier across owner types.

Accepts one of the following:

const RoleAssignmentRoleOwnerTypePlatform RoleAssignmentRoleOwnerType = "platform"

const RoleAssignmentRoleOwnerTypeCustomer RoleAssignmentRoleOwnerType = "customer"

UpdatedAt Time

Entity update timestamp

formatdate-time

ZoneID string

Zone this assignment belongs to

ScopeID stringoptional

The ID of the scoped resource. Null when the assignment is unscoped.

ScopeType stringoptional

The kind of resource this grant is scoped to (e.g. zone). Null when the assignment is unscoped (applies to the owning zone itself).

type RoleAssignmentCreate struct{…}

Schema for assigning a role to a principal. Provide exactly one of role_id or role_identifier. When role_identifier is used, owner_type is required to disambiguate roles that share an identifier across owner types; owner_type must be omitted when role_id is used.

OwnerType RoleAssignmentCreateOwnerTypeoptional

Owner type of the role to assign. Required with role_identifier (an identifier is unique only per owner type); must be omitted with role_id.

Accepts one of the following:

const RoleAssignmentCreateOwnerTypePlatform RoleAssignmentCreateOwnerType = "platform"

const RoleAssignmentCreateOwnerTypeCustomer RoleAssignmentCreateOwnerType = "customer"

RoleID stringoptional

ID of the role to assign. Provide exactly one of role_id or role_identifier; owner_type must be omitted when role_id is used.

RoleIdentifier stringoptional

minLength1

maxLength255

ScopeID stringoptional

The ID of the resource to scope the grant to. Provide together with scope_type, or omit both for an unscoped assignment. When scope_type is zone, this must reference a different zone in the same organization.

minLength1

ScopeType stringoptional

The kind of resource to scope the grant to (e.g. zone). Provide together with scope_id, or omit both for an unscoped assignment (applies to the owning zone itself). Only platform roles on the org zone may carry a scope.

minLength1