Interface RoleCreate

Export

RoleCreate

Hierarchy

  • RoleCreate

Properties

attributes? description? granted_to? key name permissions?

Properties

Optional attributes

attributes?: object

optional dictionary of key-value pairs that can be used to store arbitrary metadata about this role. This metadata can be used to filter role using query parameters with attr_ prefix, currently supports only 'equals' operator

Memberof

RoleCreate

Optional description

description?: string

optional description string explaining what this role represents, or what permissions are granted to it.

Memberof

RoleCreate

Optional granted_to

granted_to?: DerivedRoleBlockEdit

Memberof

RoleCreate

key

key: string

A URL-friendly name of the role (i.e: slug). You will be able to query later using this key instead of the id (UUID) of the role.

Memberof

RoleCreate

name

name: string

The name of the role

Memberof

RoleCreate

Optional permissions

permissions?: string[]

list of action keys that define what actions this resource role is permitted to do

Memberof

RoleCreate

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc