Skip to content

Function: getPermissionSchemeGrant() ​

ts
function getPermissionSchemeGrant(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  holder?: {
   [key: string]: unknown;
     expand?: string;
     parameter?: string;
     type: string;
     value?: string;
  };
  id?: number;
  permission?: string;
  self?: string;
}>;

Defined in: src/cloud/api/permissionSchemes.ts:315

Returns a permission grant.

Permissions required: Permission to access Jira.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ expand?: | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; permissionId: number; schemeId: number; }-
parameters.expand?| "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: - all Returns all expandable information. - field Returns information about the custom field granted the permission. - group Returns information about the group that is granted the permission. - permissions Returns all permission grants for each permission scheme. - projectRole Returns information about the project role granted the permission. - user Returns information about the user who is granted the permission.
parameters.permissionId?numberThe ID of the permission grant.
parameters.schemeId?numberThe ID of the permission scheme.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; holder?: { [key: string]: unknown; expand?: string; parameter?: string; type: string; value?: string; }; id?: number; permission?: string; self?: string; }>