Skip to content

Function: getPermissionSchemes() ​

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

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

Returns a list of all permission schemes. By default only shortened beans are returned. If you want to include permissions of all the schemes, then specify the permissions expand parameter. Permissions will be included also if you specify any other expand parameter.

Parameters ​

ParameterTypeDescription
clientClient-
parameters?{ expand?: string | 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.
options?RequestOptions-

Returns ​

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