Skip to content

Function: getSharePermission() ​

ts
function getSharePermission(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  edit?: boolean;
  group?: {
   [key: string]: unknown;
     name?: string;
     self?: string;
  };
  id?: number;
  project?: {
   [key: string]: unknown;
     archived?: boolean;
     avatarUrls?: Record<string, string>;
     description?: string;
     id?: string;
     key?: string;
     name?: string;
     self?: string;
  };
  role?: {
   [key: string]: unknown;
     actors?: object[];
     description?: string;
     id?: number;
     name?: string;
     self?: string;
  };
  type?: string;
  user?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: string]: unknown;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: string]: unknown;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: string]: unknown;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: string]: unknown;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  view?: boolean;
}>;

Defined in: src/server/api/filters.ts:245

Returns a single share permission of the given filter

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ id: string; permissionId: string; }-
parameters.idstringThe filter id.
parameters.permissionId?stringThe permission id.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; edit?: boolean; group?: { [key: string]: unknown; name?: string; self?: string; }; id?: number; project?: { [key: string]: unknown; archived?: boolean; avatarUrls?: Record<string, string>; description?: string; id?: string; key?: string; name?: string; self?: string; }; role?: { [key: string]: unknown; actors?: object[]; description?: string; id?: number; name?: string; self?: string; }; type?: string; user?: { [key: string]: unknown; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; maxResults?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; maxResults?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }; view?: boolean; }>