Skip to content

Function: createPermissionScheme() ​

ts
function createPermissionScheme(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  description?: string;
  expand?: string;
  id?: number;
  name?: string;
  permissions?: object[];
  self?: string;
}>;

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

Create a new permission scheme. This method can create schemes with a defined permission set, or without.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ body?: { description?: string; expand?: string; id?: number; name?: string; permissions?: object[]; self?: string; }; expand?: string | string[]; }-
parameters.body?{ description?: string; expand?: string; id?: number; name?: string; permissions?: object[]; self?: string; }-
parameters.body.description?string-
parameters.body.expand?string-
parameters.body.id?number-
parameters.body.name?string-
parameters.body.permissions?object[]-
parameters.body.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.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; description?: string; expand?: string; id?: number; name?: string; permissions?: object[]; self?: string; }>