@itwin/access-control-client/lib/cjs/subClients/PermissionsClient.d.ts

Access control client for the iTwin platform

/** @packageDocumentation
 * @module AccessControlClient
 */
import type { AccessToken } from "@itwin/core-bentley";
import type { IPermissionsClient } from "../accessControlClientInterfaces/PermissionsClient";
import type { BentleyAPIResponse } from "../types/CommonApiTypes";
import type { Permission } from "../types/Permission";
import { BaseClient } from "./BaseClient";
/** Client API to perform iTwin permission operations.
 */
export declare class PermissionsClient extends BaseClient implements IPermissionsClient {
    /** Create a new PermissionsClient instance
     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
     */
    constructor(url?: string);
    /** Retrieves the list of all available permissions
      * @param accessToken The client access token string
      * @returns Array of permissions
      */
    getPermissions(accessToken: AccessToken): Promise<BentleyAPIResponse<Permission[]>>;
    /** Retrieves a list of permissions the identity has for a specified iTwin
      * @param accessToken The client access token string
      * @param iTwinId The id of the iTwin
      * @returns Array of permissions
      */
    getITwinPermissions(accessToken: AccessToken, iTwinId: string): Promise<BentleyAPIResponse<Permission[]>>;
}
//# sourceMappingURL=PermissionsClient.d.ts.map