Interface Role

A data access role that assigns read and write permissions to a user for each document

Export

Role

Hierarchy

  • Role

Properties

_id? additional_fields? apply_when? delete? fields? insert? name? search? write?

Properties

Optional _id

_id?: any

The role's unique ObjectId identifier.

Memberof

Role

Optional additional_fields

additional_fields?: FieldLevelPermissions

Field-level rules for any fields that are not explicitly configured in the role's properties.

Memberof

Role

Optional apply_when

apply_when?: any

A rule expression.

Memberof

Role

Optional delete

delete?: any

A rule expression.

Memberof

Role

Optional fields

fields?: {
    [key: string]: any;
}

An object that maps document field names to read and write permissions for the field and its children.

Type declaration

  • [key: string]: any

Memberof

Role

Optional insert

insert?: any

A rule expression.

Memberof

Role

Optional name

name?: any

The role's name.

Memberof

Role

Optional search

search?: any

A rule expression.

Memberof

Role

Optional write

write?: any

A rule expression.

Memberof

Role

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc