Function: getPermissionSchemeGrant()
function getPermissionSchemeGrant(
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:203
Returns a permission grant identified by the given id.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { expand?: string | string[]; permissionId: number; schemeId: number; } | - |
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.permissionId? | number | The id of the permission grant. |
parameters.schemeId? | number | The id of the permission scheme. |
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; }>