Skip to content

Function: setSpaceRoleAssignments()

ts
function setSpaceRoleAssignments(client, parameters): Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     base?: string;
     byOperation?: string;
     collection?: string;
     context?: string;
     download?: string;
     editui?: string;
     edituiv2?: string;
     next?: string;
     prev?: string;
     self?: string;
     tinyui?: string;
     webui?: string;
  };
  results?: object[];
}>;

Defined in: src/v2/api/spaceRoles.ts:191

Sets space role assignments as specified in the payload. For each entry, if roleId is provided the principal is assigned to that role. If roleId is omitted, the role assignment for that principal is removed, if it exists.

Available on tenants with Role-Based Access Control.

Permissions required: Permission to manage roles in the space.

Parameters

ParameterTypeDescription
clientClient-
parameters{ body?: Record&lt;string, any>; id: number; }-
parameters.body?Record&lt;string, any>-
parameters.idnumberThe ID of the space for which to retrieve assignments.

Returns

Promise&lt;{ [key: string]: unknown; _links?: { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; }; results?: object[]; }>