Function: getPermissions()

function getPermissions(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  permissions?: Record<string, {
   [key: string]: unknown;
     description?: string;
     id?: string;
     key?: string;
     name?: string;
     type?: string & object | "PROJECT" | "GLOBAL";
  }>;
}>;

Defined in: src/server/api/permissions.ts:9

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

Parameter	Type	Description
client	Client	-
parameters?	{ issueId?: string; issueKey?: string; projectId?: string; projectKey?: string; }	-
parameters.issueId?	string	Id of the issue to scope returned permissions for.
parameters.issueKey?	string	Key of the issue to scope returned permissions for.
parameters.projectId?	string	Id of project to scope returned permissions for.
parameters.projectKey?	string	Key of project to scope returned permissions for.
options?	RequestOptions	-

Returns

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