Class Permissions

Readonlyuser

create

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

• 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.
  • Optionaloptions: RequestOptions

  Returns Promise<PermissionResponse>

query

• query(query, options?): QueryIterator<any>

• Query all permissions.

  Parameters

  • query: SqlQuerySpec

    Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
  • Optionaloptions: FeedOptions

  Returns QueryIterator<any>
• query<T>(query, options?): QueryIterator<T>

• 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.
  • Optionaloptions: FeedOptions

  Returns QueryIterator<T>

readAll

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

• Read all permissions.

  Parameters

  • Optionaloptions: FeedOptions

  Returns QueryIterator<PermissionDefinition & Resource>

  Example: Read all permissions to array.

  const {body: permissionList} = await user.permissions.readAll().fetchAll();
  Copy

upsert

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

• Upsert a permission.

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

  Parameters

  • body: PermissionDefinition
  • Optionaloptions: RequestOptions

  Returns Promise<PermissionResponse>