Function: deleteRolesById()

deleteRolesById<ThrowOnError>(options): RequestResult<DeleteRolesByIdResponses, DeleteRolesByIdErrors, ThrowOnError>

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

Permanently removes a specific role from the system by its unique identifier. The DeleteRole endpoint facilitates the decommissioning of roles that are no longer required, ensuring that the operation is performed only by users with the requisite administrative authority. This operation involves cleaning up the role record and ensuring that the system's security integrity is maintained. Upon successful deletion, a 204 No Content status is returned, confirming that the resource has been removed.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<DeleteRolesByIdData, ThrowOnError>

Returns

RequestResult<DeleteRolesByIdResponses, DeleteRolesByIdErrors, ThrowOnError>