Skip to main content

CreateRoleInput

Input for creating a custom role. The reserved names admin and viewer are rejected server-side.

input CreateRoleInput {
name: String!
title: String
description: String
scopes: [String!]
appliesTo: [String!]
grantsAt: [String!]
}

Fields

CreateRoleInput.name ● String! non-null scalar

URL-safe role name (required, non-empty, no path separators).

CreateRoleInput.title ● String scalar

Human-readable title (optional).

CreateRoleInput.description ● String scalar

Optional description.

CreateRoleInput.scopes ● [String!] list scalar

UMA scopes the role grants.

CreateRoleInput.appliesTo ● [String!] list scalar

Entity types the role applies to.

CreateRoleInput.grantsAt ● [String!] list scalar

Tenancy levels at which the role grants access.

Member Of

createRole mutation