Skip to content

PlatformRoleUpsertRequest

A custom role to create or update via roles.upsert().

Properties

Property Type Description
actionsGrantedByRole? string[] Fully qualified names of the actions the role grants (e.g. AUTHZ.ROLE.READ) — pick them from roles.getActions().
id? string GUID of the role to update; omit to create a new role.
organizationId string Organization (account) GUID the role belongs to.
roleDescription string Human-readable description.
roleName string Role name.
roleScopeType string Scope level the role applies at (e.g. ORGANIZATION, TENANT).
roleService? string Name of the service that owns the role.
tenantId? string Tenant the role belongs to, for tenant-scoped roles.