Options
All
  • Public
  • Public/Protected
  • All
Menu

Details of a permission and its availability to a user.

Hierarchy

  • UserPermission

Indexable

[key: string]: any

Index

Properties

Optional deprecatedKey

deprecatedKey: boolean

Indicate whether the permission key is deprecated. Note that deprecated keys cannot be used in the permissions parameter of Get my permissions. Deprecated keys are not returned by Get all permissions.

Optional description

description: string

The description of the permission.

Optional havePermission

havePermission: boolean

Whether the permission is available to the user in the queried context.

Optional id

id: string

The ID of the permission. Either id or key must be specified. Use Get all permissions to get the list of permissions.

Optional key

key: string

The key of the permission. Either id or key must be specified. Use Get all permissions to get the list of permissions.

Optional name

name: string

The name of the permission.

Optional type

type: "PROJECT" | "GLOBAL"

The type of the permission.

Legend

  • Namespace
  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class
  • Class with type parameter
  • Enumeration

Generated using TypeDoc