Interface UserPermission

Details of a permission and its availability to a user.

interface UserPermission {
    deprecatedKey?: boolean;
    description?: string;
    havePermission?: boolean;
    id?: string;
    key?: string;
    name?: string;
    type?: "GLOBAL" | "PROJECT";
}

Hierarchy

  • Record<string, unknown>
    • UserPermission

Properties

deprecatedKey? description? havePermission? id? key? name? type?

Properties

OptionaldeprecatedKey

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.

Optionaldescription

description?: string

The description of the permission.

OptionalhavePermission

havePermission?: boolean

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

Optionalid

id?: string

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

Optionalkey

key?: string

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

Optionalname

name?: string

The name of the permission.

Optionaltype

type?: "GLOBAL" | "PROJECT"

The type of the permission.

Settings

Member Visibility

On This Page

Properties