@itwin/access-control-client/lib/esm/accessControlClientInterfaces/GroupClient.d.ts

Access control client for the iTwin platform

import type { AccessToken } from "@itwin/core-bentley";
import type { BentleyAPIResponse } from "../types/CommonApiTypes";
import type { Group, MultipleGroupsResponse, SingleGroupResponse } from "../types/Groups";
export interface IGroupsClient {
    /** Retrieves a list of groups the for a specified iTwin */
    getITwinGroups(accessToken: AccessToken, iTwinId: string): Promise<BentleyAPIResponse<MultipleGroupsResponse>>;
    /** Retrieves a group for a specified iTwin */
    getITwinGroup(accessToken: AccessToken, iTwinId: string, groupId: string): Promise<BentleyAPIResponse<SingleGroupResponse>>;
    /** Creates a new iTwin group */
    createITwinGroup(accessToken: AccessToken, iTwinId: string, group: Pick<Group, "name" | "description">): Promise<BentleyAPIResponse<SingleGroupResponse>>;
    /** Removes an existing iTwin group */
    deleteITwinGroup(accessToken: AccessToken, iTwinId: string, groupId: string): Promise<BentleyAPIResponse<undefined>>;
    /** Updates an existing iTwin group */
    updateITwinGroup(accessToken: AccessToken, iTwinId: string, groupId: string, group: Partial<Pick<Group, "name" | "description"> & {
        members: string[];
        imsGroups: string[];
    }>): Promise<BentleyAPIResponse<SingleGroupResponse>>;
}
//# sourceMappingURL=GroupClient.d.ts.map