updateWorkspaceRole()
Patches a custom workspace role definition.
Usage
The following example shows a basic usage of the backend client from @wacht/nextjs/server.
import { wachtClient } from '@wacht/nextjs/server';export async function example() { const client = await wachtClient(); const workspaceId: string = 'workspaceid-123'; const roleId: string = 'roleid-123'; const request: UpdateWorkspaceRoleRequest = { name: 'Workspace Editor', }; return client.workspaces.updateWorkspaceRole(workspaceId, roleId, request);}Signature
function updateWorkspaceRole( workspaceId: string, roleId: string, request: UpdateWorkspaceRoleRequest, client?: WachtClient,): Promise<WorkspaceRole>Parameters
›workspaceId: string;
workspaceId: string;Identifier for the target resource.
›roleId: string;
roleId: string;Identifier for the target resource.
›request: UpdateWorkspaceRoleRequest;
request: UpdateWorkspaceRoleRequest;Request payload object sent to the backend API.
›name?: string | undefined;
name?: string | undefined;Display name for the target resource.
Return value
›result?: WorkspaceRole | undefined;
result?: WorkspaceRole | undefined;Operation result payload.