UNPKG

@itwin/access-control-client

Version:

Access control client for the iTwin platform

45 lines 2.44 kB
/** @packageDocumentation * @module AccessControlClient */ import type { AccessToken } from "@itwin/core-bentley"; import type { AccessControlAPIResponse, AccessControlQueryArg, AddGroupMember, GroupMember, IGroupMembersClient } from "../accessControlTypes"; import { BaseClient } from "./BaseClient"; export declare class GroupMembersClient extends BaseClient implements IGroupMembersClient { constructor(url?: string); /** Retrieves a list of iTwin group members and their roles assignments. * @param accessToken The client access token string * @param iTwinId The id of the iTwin * @returns Array of members */ queryITwinGroupMembersAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<GroupMember[]>>; /** Retrieves a specific group member for a specified iTwin. * @param accessToken The client access token string * @param iTwinId The id of the iTwin * @param memberId The id of the member * @returns Member */ getITwinGroupMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<GroupMember>>; /** Add new iTwin group members * @param accessToken The client access token string * @param iTwinId The id of the iTwin * @param newMembers The list of new members to be added along with their role * @returns Member[] */ addITwinGroupMembersAsync(accessToken: AccessToken, iTwinId: string, newMembers: AddGroupMember[]): Promise<AccessControlAPIResponse<GroupMember[]>>; /** Remove the specified group member from the iTwin * @param accessToken The client access token string * @param iTwinId The id of the iTwin * @param memberId The id of the member * @returns No Content */ removeITwinGroupMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>; /** Update iTwin group member roles * @param accessToken The client access token string * @param iTwinId The id of the iTwin * @param memberId The id of the member * @param roleIds The ids of the roles to be assigned * @returns Member */ updateITwinGroupMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<AccessControlAPIResponse<GroupMember>>; } //# sourceMappingURL=GroupMembersClient.d.ts.map