Function getPermissions

getPermissions(
    client: Client,
    parameters?: {
        issueId?: string;
        issueKey?: string;
        projectId?: string;
        projectKey?: string;
    },
    options?: RequestOptions,
): Promise<
    {
        permissions?: Record<
            string,
            {
                description?: string;
                id?: string;
                key?: string;
                name?: string;
                type?: string & {}
                | "PROJECT"
                | "GLOBAL";
                [key: string]: unknown;
            },
        >;
        [key: string]: unknown;
    },
>
Returns all permissions in the system and whether the currently logged in user has them. You can optionally provide a specific context to get permissions for (projectKey OR projectId OR issueKey OR issueId)
Parameters
- client: Client
- Optionalparameters: { issueId?: string; issueKey?: string; projectId?: string; projectKey?: string }
  - OptionalissueId?: string
    
    Id of the issue to scope returned permissions for.
  - OptionalissueKey?: string
    
    Key of the issue to scope returned permissions for.
  - OptionalprojectId?: string
    
    Id of project to scope returned permissions for.
  - OptionalprojectKey?: string
    
    Key of project to scope returned permissions for.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        permissions?: Record<
            string,
            {
                description?: string;
                id?: string;
                key?: string;
                name?: string;
                type?: string & {}
                | "PROJECT"
                | "GLOBAL";
                [key: string]: unknown;
            },
        >;
        [key: string]: unknown;
    },
>
- Defined in src/server/api/permissions.ts:9

Function getPermissions

Parameters

`Optional`issueId?: string

`Optional`issueKey?: string

`Optional`projectId?: string

`Optional`projectKey?: string

Settings

Function getPermissions

Parameters

OptionalissueId?: string

OptionalissueKey?: string

OptionalprojectId?: string

OptionalprojectKey?: string

Returns Promise< { permissions?: Record< string, { description?: string; id?: string; key?: string; name?: string; type?: string & {} | "PROJECT" | "GLOBAL"; [key: string]: unknown; }, >; [key: string]: unknown; },>

Settings

`Optional`issueId?: string

`Optional`issueKey?: string

`Optional`projectId?: string

`Optional`projectKey?: string

Returns Promise<
{
permissions?: Record<
string,
{
description?: string;
id?: string;
key?: string;
name?: string;
type?: string & {}
| "PROJECT"
| "GLOBAL";
[key: string]: unknown;
},
>;
[key: string]: unknown;
},
>