UNPKG

@itwin/access-control-client

Version:

Access control client for the iTwin platform

45 lines 2.5 kB
/** @packageDocumentation * @module AccessControlClient */ import type { AccessToken } from "@itwin/core-bentley"; import type { AccessControlAPIResponse, AccessControlQueryArg, AddUserMember, AddUserMemberResponse, IUserMembersClient, UserMember } from "../accessControlTypes"; import { BaseClient } from "./BaseClient"; export declare class UserMembersClient extends BaseClient implements IUserMembersClient { constructor(url?: string); /** Retrieves a list of iTwin user members and their roles assignments. * @param accessToken The client access token string * @param iTwinId The id of the iTwin * @returns Array of members */ queryITwinUserMembersAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<UserMember[]>>; /** Retrieves a specific user 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 */ getITwinUserMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<UserMember>>; /** Add new iTwin user members * @param accessToken The client access token string * @param iTwinId The id of the iTwin * @param newMembers The list of members to add or invite, along with their role * @returns AddUserMemberResponse -- the added or invited user members */ addITwinUserMembersAsync(accessToken: AccessToken, iTwinId: string, newMembers: AddUserMember[]): Promise<AccessControlAPIResponse<AddUserMemberResponse>>; /** Remove the specified user 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 */ removeITwinUserMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>; /** Update iTwin user 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 */ updateITwinUserMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<AccessControlAPIResponse<UserMember>>; } //# sourceMappingURL=UserMembersClient.d.ts.map