Class Permissions

Use to create, replace, query, and read all Permissions.

see: Permission to read, replace, or delete a specific permission by id.

Hierarchy

Permissions

Index

Properties

user

Methods

Properties

user

user: User

The parent User.

Methods

create

create(body: PermissionDefinition, options?: RequestOptions): Promise<PermissionResponse>

- Defined in client/Permission/Permissions.ts:72
Create a permission.

A permission represents a per-User Permission to access a specific resource e.g. Item or Container.

Parameters
- body: PermissionDefinition
  
  Represents the body of the permission.
- Optional options: RequestOptions
Returns Promise<PermissionResponse>

query

query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>
query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

- Defined in client/Permission/Permissions.ts:30
Query all permissions.

Parameters
- query: SqlQuerySpec
  
  Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
- Optional options: FeedOptions
Returns QueryIterator<any>
- Defined in client/Permission/Permissions.ts:36
Query all permissions.

Type parameters
- T
Parameters
- query: SqlQuerySpec
  
  Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
- Optional options: FeedOptions
Returns QueryIterator<T>

readAll

readAll(options?: FeedOptions): QueryIterator<PermissionDefinition & Resource>

- Defined in client/Permission/Permissions.ts:61
Read all permissions.
example
Read all permissions to array.
```
const {body: permissionList} = await user.permissions.readAll().toArray();
```
Parameters
- Optional options: FeedOptions
Returns QueryIterator<PermissionDefinition & Resource>

upsert

upsert(body: PermissionDefinition, options?: RequestOptions): Promise<PermissionResponse>

- Defined in client/Permission/Permissions.ts:98
Upsert a permission.

A permission represents a per-User Permission to access a specific resource e.g. Item or Container.

Parameters
- body: PermissionDefinition
- Optional options: RequestOptions
Returns Promise<PermissionResponse>

Generated using TypeDoc