Type Alias GroupsAPI

type GroupsAPI = {
    clearCache: typeof clearCache;
    createGroup: typeof createGroup;
    deleteGroup: typeof deleteGroup;
    filterGroups: typeof filterGroups;
    getGroup: typeof getGroup;
    getGroups: typeof getGroups;
    getGroupsSettings: typeof getGroupsSettings;
    patchGroup: typeof patchGroup;
    patchGroupsSettings: typeof patchGroupsSettings;
}
Index

Properties

clearCache createGroup deleteGroup filterGroups getGroup getGroups getGroupsSettings patchGroup patchGroupsSettings

Properties

clearCache: typeof clearCache

Clears the cache for groups api requests.

createGroup: typeof createGroup

Creates a new group. The maximum number of groups a tenant can have is 10,000. Group names are case-sensitive, and must be unique.

Param: body

an object with the body content

CreateGroupHttpError

deleteGroup: typeof deleteGroup

Deletes the requested group.

The ID of the group to delete.

DeleteGroupHttpError

filterGroups: typeof filterGroups

Retrieves a list of groups matching the filter using advanced query string.

an object with query parameters

Param: body

an object with the body content

FilterGroupsHttpError

getGroup: typeof getGroup

Returns the requested group.

The group's unique identifier

GetGroupHttpError

getGroups: typeof getGroups

Returns a list of groups with cursor-based pagination.

an object with query parameters

GetGroupsHttpError

getGroupsSettings: typeof getGroupsSettings

Returns the tenant's group settings, such as whether automatic group creation and IdP group synchronization are enabled or disabled, and roles assigned to system groups.

GetGroupsSettingsHttpError

patchGroup: typeof patchGroup

Updates the requested group.

The ID of the group to update.

Param: body

an object with the body content

PatchGroupHttpError

patchGroupsSettings: typeof patchGroupsSettings

Updates the tenant's group settings, such as whether automatic group creation and IdP group synchronization are enabled or disabled, and roles assigned to system groups.

Param: body

an object with the body content

PatchGroupsSettingsHttpError

Settings

Member Visibility

On This Page

Properties