Function: patchRolesById()

patchRolesById<ThrowOnError>(options): RequestResult<PatchRolesByIdResponses, PatchRolesByIdErrors, ThrowOnError>

Defined in: app/api/sdk.gen.ts:896

Partially updates the properties of an existing role using a JSON Patch document. The PatchRole endpoint provides a highly flexible mechanism for modifying specific attributes of a role—such as its name or description—without the need to transmit the entire role object. This endpoint validates the proposed changes against the role's domain model and ensures that the user is authorized to perform the requested modifications before persisting the changes to the system.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<PatchRolesByIdData, ThrowOnError>

Returns

RequestResult<PatchRolesByIdResponses, PatchRolesByIdErrors, ThrowOnError>