@itwin/access-control-client/lib/cjs/accessControlClientInterfaces/GroupMembersClient.d.ts

Access control client for the iTwin platform

import type { AccessToken } from "@itwin/core-bentley";
import type { BentleyAPIResponse, ODataQueryParams } from "../types/CommonApiTypes";
import type { GroupMemberAssignment, MultipleGroupMembersResponse, SingleGroupMemberResponse } from "../types/GroupMember";
import type { Links } from "../types/links";
export interface IGroupMembersClient {
    /** Retrieves a list of group members and their roles assigned to a specified iTwin. */
    queryITwinGroupMembers(accessToken: AccessToken, iTwinId: string, arg?: Pick<ODataQueryParams, "top" | "skip">): Promise<BentleyAPIResponse<MultipleGroupMembersResponse & {
        _links: Links;
    }>>;
    /** Retrieves a specific group member for a specified iTwin. */
    getITwinGroupMember(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<BentleyAPIResponse<SingleGroupMemberResponse>>;
    /** Add new iTwin group members */
    addITwinGroupMembers(accessToken: AccessToken, iTwinId: string, newMembers: GroupMemberAssignment): Promise<BentleyAPIResponse<MultipleGroupMembersResponse>>;
    /**  Remove the specified iTwin group member */
    removeITwinGroupMember(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<BentleyAPIResponse<undefined>>;
    /**  Update iTwin group member roles */
    updateITwinGroupMember(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<BentleyAPIResponse<SingleGroupMemberResponse>>;
}
//# sourceMappingURL=GroupMembersClient.d.ts.map