Skip to content

Function: getPermissionSchemeGrants() ​

ts
function getPermissionSchemeGrants(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  expand?: string;
  permissions?: object[];
}>;

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

Returns all permission grants for a permission scheme.

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")[]; 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: - permissions Returns all permission grants for each permission scheme. - user Returns information about the user who is granted the permission. - group Returns information about the group that is granted the permission. - projectRole Returns information about the project role granted the permission. - field Returns information about the custom field granted the permission. - all Returns all expandable information.
parameters.schemeId?numberThe ID of the permission scheme.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; expand?: string; permissions?: object[]; }>