Skip to content

Function: setActors() ​

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

Defined in: src/server/api/projects.ts:529

Updates a project role to include the specified actors (users or groups). Can be also used to clear roles to not include any users or groups. For user actors, their usernames should be used.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ body: { categorisedActors?: Record<string, string[]>; id?: number; }; id: number; projectIdOrKey: string; }-
parameters.body{ categorisedActors?: Record<string, string[]>; id?: number; }-
parameters.body.categorisedActors?Record<string, string[]>-
parameters.body.id?number-
parameters.id?numberThe project role id
parameters.projectIdOrKey?stringThe project id or project key
options?RequestOptions-

Returns ​

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