@itwin/access-control-client
Version:
Access control client for the iTwin platform
30 lines • 1.65 kB
TypeScript
/** @packageDocumentation
* @module AccessControlClient
*/
import type { AccessToken } from "@itwin/core-bentley";
import type { AccessControlAPIResponse, AccessControlQueryArg, AddOwnerMemberResponse, IOwnerMembersClient, OwnerMember } from "../accessControlTypes";
import { BaseClient } from "./BaseClient";
export declare class OwnerMembersClient extends BaseClient implements IOwnerMembersClient {
constructor(url?: string);
/** Retrieves a list of iTwin owner members on an iTwin.
* @param accessToken The client access token string
* @param iTwinId The id of the iTwin
* @returns Array of members
*/
queryITwinOwnerMembersAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<OwnerMember[]>>;
/** Add new iTwin owner member
* @param accessToken The client access token string
* @param iTwinId The id of the iTwin
* @param newMember The new owner member to add or invite
* @returns AddOwnerMemberResponse -- the added or invited owner
*/
addITwinOwnerMemberAsync(accessToken: AccessToken, iTwinId: string, newMember: OwnerMember): Promise<AccessControlAPIResponse<AddOwnerMemberResponse>>;
/** Remove the specified owner 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
*/
removeITwinOwnerMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>;
}
//# sourceMappingURL=OwnerMembersClient.d.ts.map