Function: createPermissionGrant()

function createPermissionGrant(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  holder?: {
   [key: string]: unknown;
     expand?: string;
     field?: {
      [key: string]: unknown;
        clauseNames?: string[];
        custom?: boolean;
        id?: string;
        name?: string;
        navigable?: boolean;
        orderable?: boolean;
        schema?: {
         [key: string]: unknown;
           custom?: string;
           customId?: number;
           items?: string;
           system?: string;
           type?: string;
        };
        searchable?: boolean;
     };
     group?: {
      [key: string]: unknown;
        name?: string;
        self?: string;
     };
     parameter?: string;
     projectRole?: {
      [key: string]: unknown;
        actors?: object[];
        description?: string;
        id?: number;
        name?: string;
        self?: string;
     };
     type?: string;
     user?: {
      [key: string]: unknown;
        active?: boolean;
        avatarUrls?: Record<string, string>;
        displayName?: string;
        emailAddress?: string;
        key?: string;
        name?: string;
        self?: string;
        timeZone?: string;
     };
  };
  id?: number;
  permission?: string;
  self?: string;
}>;

Defined in: src/server/api/permissionSchemes.ts:178

Creates a permission grant in a permission scheme.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ expand?: string | string[]; holder?: { expand?: string; field?: { clauseNames?: string[]; custom?: boolean; id?: string; name?: string; navigable?: boolean; orderable?: boolean; schema?: { custom?: string; customId?: number; items?: string; system?: string; type?: string; }; searchable?: boolean; }; group?: { name?: string; self?: string; }; parameter?: string; projectRole?: { actors?: object[]; description?: string; id?: number; name?: string; self?: string; }; type?: string; user?: { active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; }; id?: number; permission?: string; schemeId: number; self?: string; }	-
parameters.expand?	string | string[]	Use expand to include full beans in the response. This parameter accepts a comma-separated list of expandable elements. Use 'permissions' to include permissions in the response.
parameters.holder?	{ expand?: string; field?: { clauseNames?: string[]; custom?: boolean; id?: string; name?: string; navigable?: boolean; orderable?: boolean; schema?: { custom?: string; customId?: number; items?: string; system?: string; type?: string; }; searchable?: boolean; }; group?: { name?: string; self?: string; }; parameter?: string; projectRole?: { actors?: object[]; description?: string; id?: number; name?: string; self?: string; }; type?: string; user?: { active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; }	-
parameters.holder.expand?	string	-
parameters.holder.field?	{ clauseNames?: string[]; custom?: boolean; id?: string; name?: string; navigable?: boolean; orderable?: boolean; schema?: { custom?: string; customId?: number; items?: string; system?: string; type?: string; }; searchable?: boolean; }	-
parameters.holder.field.clauseNames?	string[]	-
parameters.holder.field.custom?	boolean	-
parameters.holder.field.id?	string	-
parameters.holder.field.name?	string	-
parameters.holder.field.navigable?	boolean	-
parameters.holder.field.orderable?	boolean	-
parameters.holder.field.schema?	{ custom?: string; customId?: number; items?: string; system?: string; type?: string; }	-
parameters.holder.field.schema.custom?	string	-
parameters.holder.field.schema.customId?	number	-
parameters.holder.field.schema.items?	string	-
parameters.holder.field.schema.system?	string	-
parameters.holder.field.schema.type?	string	-
parameters.holder.field.searchable?	boolean	-
parameters.holder.group?	{ name?: string; self?: string; }	-
parameters.holder.group.name?	string	-
parameters.holder.group.self?	string	-
parameters.holder.parameter?	string	-
parameters.holder.projectRole?	{ actors?: object[]; description?: string; id?: number; name?: string; self?: string; }	-
parameters.holder.projectRole.actors?	object[]	-
parameters.holder.projectRole.description?	string	-
parameters.holder.projectRole.id?	number	-
parameters.holder.projectRole.name?	string	-
parameters.holder.projectRole.self?	string	-
parameters.holder.type?	string	-
parameters.holder.user?	{ active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }	-
parameters.holder.user.active?	boolean	-
parameters.holder.user.avatarUrls?	Record<string, string>	-
parameters.holder.user.displayName?	string	-
parameters.holder.user.emailAddress?	string	-
parameters.holder.user.key?	string	-
parameters.holder.user.name?	string	-
parameters.holder.user.self?	string	-
parameters.holder.user.timeZone?	string	-
parameters.id?	number	-
parameters.permission?	string	-
parameters.schemeId?	number	The id of the permission scheme.
parameters.self?	string	-
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; holder?: { [key: string]: unknown; expand?: string; field?: { [key: string]: unknown; clauseNames?: string[]; custom?: boolean; id?: string; name?: string; navigable?: boolean; orderable?: boolean; schema?: { [key: string]: unknown; custom?: string; customId?: number; items?: string; system?: string; type?: string; }; searchable?: boolean; }; group?: { [key: string]: unknown; name?: string; self?: string; }; parameter?: string; projectRole?: { [key: string]: unknown; actors?: object[]; description?: string; id?: number; name?: string; self?: string; }; type?: string; user?: { [key: string]: unknown; active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; }; id?: number; permission?: string; self?: string; }>