Interface ResourceRead

Export

ResourceRead

Hierarchy

  • ResourceRead

Properties

action_groups? actions? attributes? created_at description? environment_id id key name organization_id project_id relations? roles? updated_at urn?

Properties

Optional action_groups

action_groups?: {
    [key: string]: string[];
}

Type declaration

  • [key: string]: string[]

Memberof

ResourceRead

Optional actions

actions?: {
    [key: string]: ActionBlockRead;
}

A actions definition block, typically contained within a resource type definition block. The actions represents the ways you can interact with a protected resource.

Type declaration

Memberof

ResourceRead

Optional attributes

attributes?: {
    [key: string]: AttributeBlockRead;
}

Attributes that each resource of this type defines, and can be used in your ABAC policies.

Type declaration

Memberof

ResourceRead

created_at

created_at: string

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

Memberof

ResourceRead

Optional description

description?: string

An optional longer description of what this resource respresents in your system

Memberof

ResourceRead

environment_id

environment_id: string

Unique id of the environment that the resource belongs to.

Memberof

ResourceRead

id

id: string

Unique id of the resource

Memberof

ResourceRead

key

key: string

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

Memberof

ResourceRead

name

name: string

The name of the resource

Memberof

ResourceRead

organization_id

organization_id: string

Unique id of the organization that the resource belongs to.

Memberof

ResourceRead

project_id

project_id: string

Unique id of the project that the resource belongs to.

Memberof

ResourceRead

Optional relations

relations?: {
    [key: string]: RelationBlockRead;
}

A relations definition block, typically contained within a resource type definition block. The relations represents the ways you can interact with a protected resource.

Type declaration

  • [key: string]: RelationBlockRead

Memberof

ResourceRead

Optional roles

roles?: object

Roles defined on this resource. The key is the role name, and the value contains the role properties such as granted permissions, etc.

Memberof

ResourceRead

updated_at

updated_at: string

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

Memberof

ResourceRead

Optional urn

urn?: string

The URN (Uniform Resource Name) of the resource

Memberof

ResourceRead

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc