Interface RoleRead

Export

RoleRead

Hierarchy

  • RoleRead

Properties

attributes? created_at description? environment_id granted_to? id key name organization_id permissions? project_id updated_at

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

RoleRead

created_at

created_at: string

Date and time when the role was created (ISO_8601 format).

Memberof

RoleRead

Optional description

description?: string

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

Memberof

RoleRead

environment_id

environment_id: string

Unique id of the environment that the role belongs to.

Memberof

RoleRead

Optional granted_to

granted_to?: DerivedRoleBlockRead

Memberof

RoleRead

id

id: string

Unique id of the role

Memberof

RoleRead

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

RoleRead

name

name: string

The name of the role

Memberof

RoleRead

organization_id

organization_id: string

Unique id of the organization that the role belongs to.

Memberof

RoleRead

Optional permissions

permissions?: string[]

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

Memberof

RoleRead

project_id

project_id: string

Unique id of the project that the role belongs to.

Memberof

RoleRead

updated_at

updated_at: string

Date and time when the role was last updated/modified (ISO_8601 format).

Memberof

RoleRead

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc