Function: patchRolealiasesById()

patchRolealiasesById<ThrowOnError>(options): RequestResult<PatchRolealiasesByIdResponses, PatchRolealiasesByIdErrors, ThrowOnError>

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

Partially updates an existing role alias using a JSON Patch document. The PatchRoleAlias endpoint provides the flexibility to modify specific fields of an alias—such as the displayed name—without requiring the submission of the entire object. This is particularly useful for fine-tuning role nomenclature while ensuring that the updates are validated against system constraints and authorized by the proper administrative permissions.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<PatchRolealiasesByIdData, ThrowOnError>

Returns

RequestResult<PatchRolealiasesByIdResponses, PatchRolealiasesByIdErrors, ThrowOnError>