Skip to main content

Role

A tenant (organization) role: either a predefined platform role (admin/viewer) or a custom role defined by an organization admin.

type Role {
  name: String!
  title: String!
  description: String!
  scopes: [String!]!
  appliesTo: [String!]!
  grantsAt: [String!]!
  predefined: Boolean!
}

Fields​

Role.name ● String! non-null scalar​

The role's unique name within the tenant (URL-safe identifier).

Role.title ● String! non-null scalar​

Human-readable title.

Role.description ● String! non-null scalar​

Optional description of what the role is for.

Role.scopes ● [String!]! non-null scalar​

UMA scopes this role grants (e.g. "edit", "view").

Role.appliesTo ● [String!]! non-null scalar​

Entity types this role applies to (e.g. "bot", "strategy").

Role.grantsAt ● [String!]! non-null scalar​

Tenancy levels at which this role grants access (e.g. "workspace").

Role.predefined ● Boolean! non-null scalar​

True for the built-in admin/viewer roles, which cannot be edited or deleted as custom roles (but can still be assigned to members).

Returned By​

createRole mutation ● roles query ● updateRole mutation