Type Alias RolesAPI

type RolesAPI = {
    clearCache: typeof clearCache;
    createRole: typeof createRole;
    deleteRole: typeof deleteRole;
    getRole: typeof getRole;
    getRoles: typeof getRoles;
    patchRole: typeof patchRole;
}
Index

Properties

clearCache: typeof clearCache

Clears the cache for roles api requests.

createRole: typeof createRole

Creates a custom role. Role names must be unique, and there is a maximum of 500 custom roles per tenant. Requestor must be assigned the TenantAdmin role.

an object with the body content

CreateRoleHttpError

deleteRole: typeof deleteRole

Deletes the requested role. Role can only be deleted if it has been unassigned from all users and groups. Only applicable to roles of type custom. Requestor must be assigned the TenantAdmin role.

The unique identifier for the role.

DeleteRoleHttpError

getRole: typeof getRole

Returns the requested role.

The unique identifier for the role.

GetRoleHttpError

getRoles: typeof getRoles

Returns a list of roles using cursor-based pagination.

an object with query parameters

GetRolesHttpError

patchRole: typeof patchRole

Updates the requested role. Only applicable to roles of type custom. Requestor must be assigned the TenantAdmin role.

The unique identifier for the role.

an object with the body content

PatchRoleHttpError