Interface ResourceCreate

Export

ResourceCreate

Hierarchy

  • ResourceCreate

Properties

actions attributes? description? key name relations? roles? urn?

Properties

actions

actions: {
    [key: string]: ActionBlockEditable;
}

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

ResourceCreate

Optional attributes

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

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

Type declaration

Memberof

ResourceCreate

Optional description

description?: string

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

Memberof

ResourceCreate

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

ResourceCreate

name

name: string

The name of the resource

Memberof

ResourceCreate

Optional relations

relations?: object

Relations to other resources. The key is the relation key, and the value is the related resource.

Memberof

ResourceCreate

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, base roles, etc.

Memberof

ResourceCreate

Optional urn

urn?: string

The URN (Uniform Resource Name) of the resource

Memberof

ResourceCreate

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc