@itwin/access-control-client 0.1.0 → 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log - @itwin/access-control-client
+
+## 1.1.0
+
+- Added constructor parameter to AccessControlClient for custom url.
+
+## 1.0.0
+
+- Intial commit.

package/CONTRIBUTING.md

@@ -0,0 +1,90 @@
+# Contributing
+
+This project accepts contributions from other teams at Bentley.
+
+## Table of Contents
+
+- [Creating Issues and Enhancements](#creating-issues-and-enhancements)
+    - [Writing Good Bug Reports and Feature Requests](#writing-good-bug-reports-and-feature-requests)
+    - [Final Checklist](#final-checklist)
+- [Pull Requests](#pull-requests)
+    - [Submitting Pull Requests](#submitting-pull-requests)
+- [File Headers](#file-headers)
+- [Editor Config](#editor-config)
+    - [VS Code](#vs-code)
+    - [Visual Studio](#visual-studio)
+
+## Creating Issues and Enhancements
+
+Have you identified a reproducible problem in this code? Have a feature requests? Please enter a Bug or Product Backlog Item, but first make sure that you search the work items to make sure that it has not been entered yet. If you find your issue already exists, make relevant comments.
+
+All work in this repository and every pull request must have a linked work item.
+
+### Writing Good Bug Reports and Feature Requests
+
+File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue.
+
+Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes.
+
+The more information you can provide, the more likely someone will be successful at reproducing the issue and finding a fix.
+
+Please include the following with each issue:
+
+* Version of the code
+* Your operating system
+* Reproducible steps (1... 2... 3...) that cause the issue
+* What you expected to see, versus what you actually saw
+* Images, animations, or a link to a video showing the issue occurring
+* A code snippet that demonstrates the issue or a link to a code repository the developers can easily pull down to recreate the issue locally
+
+### Final Checklist
+
+Please remember to do the following:
+
+* [ ] Search work items to ensure your report is a new issue
+* [ ] Simplify your code around the issue to better isolate the problem
+
+## Pull Requests
+
+We follow a [feature branch and pull request workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow) to ensure that all code changes in this repository are code reviewed and all tests pass. This means that there will be a number of reviewers that formally review and sign off for changes. Reviewers should check for redundancy, optimization, stylization, and standardization in each changeset. While we will try to keep this repository as collaborative and open-source as possible, it must also be reliable.
+
+Every change must be tested with proper unit tests. Integration tests are highly encouraged in libraries with critical workflows to ensure end-to-end consistency.
+
+### Submitting Pull Requests
+
+- **DO** ensure you have added unit tests for your changes.
+- **DO** run all unit tests before you submit your pull request.
+- **DO** link the pull request to a Work Item.
+- **DO** ensure submissions pass all Continuous Integration and are merge conflict free.
+- **DO** follow the [.editorconfig](http://editorconfig.org/) settings for each directory.
+- **DON'T** submit large code formatting changes without discussing with the team first.
+- **DON'T** surprise us with big pull requests. Instead, file an issue and start a discussion so we can agree on a direction before you invest a large amount of time.
+- **DON'T** fix merge conflicts using a merge commit. Prefer `git rebase`.
+- **DON'T** mix independent, unrelated changes in one PR.
+
+If you are unfamiliar with creating pull requests, please read [PULL_REQUESTS.md](PULL_REQUESTS.md).
+
+These two blogs posts on contributing code to open source projects are good too: [Open Source Contribution Etiquette](http://tirania.org/blog/archive/2010/Dec-31.html) by Miguel de Icaza and [Don’t “Push” Your Pull Requests](https://www.igvita.com/2011/12/19/dont-push-your-pull-requests/) by Ilya Grigorik.
+
+## File Headers
+
+The following file headers are used in this project. Please use it for new files.
+
+```typescript
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+```
+
+## Editor Config
+
+This project uses an `.editorconfig` file to maintain a consistent style standard (braces, tabs, etc.) across all files in the solution. For more information or to find extensions for code editors other than VS Code and Visual Studio, see the [EditorConfig](https://editorconfig.org/) website.
+
+### VS Code
+
+Download the [EditorConfig for VSCode](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) to override your user/workspace settings with settings found in this repository's `.editorconfig` files.
+
+### Visual Studio
+
+Visual Studio 2017 and newer comes with EditorConfig support built in. Older versions of Visual Studio will need to install the [EditorConfig extension](https://marketplace.visualstudio.com/items?itemName=EditorConfigTeam.EditorConfig).

package/GETTINGSTARTED.md

@@ -0,0 +1,33 @@
+## Integration Test Setup
+
+Make sure an `.env` file is created in the root folder.  The following are the keys without the values:
+```
+IMJS_AUTH_AUTHORITY=""
+IMJS_URL_PREFIX=""
+IMJS_OIDC_AUTHING_BROWSER_TEST_AUTHORITY=""
+IMJS_OIDC_BROWSER_TEST_CLIENT_ID=""
+IMJS_OIDC_BROWSER_TEST_REDIRECT_URI=""
+IMJS_OIDC_BROWSER_TEST_SCOPES=""
+IMJS_OIDC_AUTHING_BROWSER_TEST_SCOPES=""
+IMJS_TEST_REGULAR_USER_NAME=""
+IMJS_TEST_REGULAR_USER_PASSWORD=""
+IMJS_TEST_REGULAR_USER_ID=""
+IMJS_TEST_ASSET_ID=""
+IMJS_TEST_PROJECT_ID=""
+IMJS_TEST_IMODEL_ID=""
+IMJS_TEST_PERMANENT_ROLE_ID1=""
+IMJS_TEST_PERMANENT_ROLE_NAME1=""
+IMJS_TEST_PERMANENT_ROLE_ID2=""
+IMJS_TEST_PERMANENT_ROLE_NAME2=""
+IMJS_TEST_TEMP_USER_EMAIL=""
+IMJS_TEST_TEMP_USER_ID=""
+```
+
+Run the following npm commands from the root folder in order.
+```
+npm i
+npm run build
+npm run test
+```
+
+`npm run test` runs a script defined in `package.json`.

package/README.md

@@ -8,7 +8,327 @@ If you have questions, or wish to contribute to iTwin.js, see our [Contributing
 
 ## About this Repository
 
-Contains the __@itwin/access-control-client__ package that wraps sending requests to the access control service. Visit the [iTwins API](https://developer.bentley.com/apis/access-control/) for more documentation on the iTwins service.
+Contains the **@itwin/access-control-client** package that wraps sending requests to the access control service. Visit the [Access Control API](https://developer.bentley.com/apis/access-control/) for more documentation on the Access Control service.
+
+## Usage examples
+
+### Get list of Roles for an iTwin
+
+```typescript
+import type { AccessToken } from "@itwin/core-bentley";
+import {
+  AccessControlClient,
+  IAccessControlClient,
+  Role,
+  AccessControlAPIResponse,
+} from "@itwin/access-control-client";
+
+/** Function that queries all Roles for a given iTwin and prints their ids to the console. */
+async function printiTwinRoleIds(): Promise<void> {
+  const accessControlClient: IAccessControlClient = new AccessControlClient();
+  const accessToken: AccessToken = { get_access_token_logic_here };
+
+  const iTwinsResponse: AccessControlAPIResponse<Role[]> =
+    await accessControlClient.roles.getITwinRolesAsync(
+      accessToken,
+      "2f981e83-47e4-4f36-8ee9-4264453688a1"
+    );
+
+  iTwinsResponse.data!.forEach((actualRole: Role) => {
+    console.log(actualRole.id);
+  });
+}
+```
+
+### Get list of Roles for an iTwin (with custom url)
+
+```typescript
+import type { AccessToken } from "@itwin/core-bentley";
+import {
+  AccessControlClient,
+  IAccessControlClient,
+  Role,
+  AccessControlAPIResponse,
+} from "@itwin/access-control-client";
+
+/** Function that queries all Roles for a given iTwin and prints their ids to the console. */
+async function printiTwinRoleIds(): Promise<void> {
+  const accessControlClient: IAccessControlClient = new AccessControlClient("https://api.bentley.com/accesscontrol/itwins");
+  const accessToken: AccessToken = { get_access_token_logic_here };
+
+  const iTwinsResponse: AccessControlAPIResponse<Role[]> =
+    await accessControlClient.roles.getITwinRolesAsync(
+      accessToken,
+      "2f981e83-47e4-4f36-8ee9-4264453688a1"
+    );
+
+  iTwinsResponse.data!.forEach((actualRole: Role) => {
+    console.log(actualRole.id);
+  });
+}
+```
+
+### Get specific role for an iTwin
+
+```typescript
+import type { AccessToken } from "@itwin/core-bentley";
+import {
+  AccessControlClient,
+  IAccessControlClient,
+  Role,
+  AccessControlAPIResponse,
+} from "@itwin/access-control-client";
+
+/** Function that gets a specific role for an iTwin and then prints the id and displayName to the console. */
+async function printiTwinRole(): Promise<void> {
+  const accessControlClient: IAccessControlClient = new AccessControlClient();
+  const accessToken: AccessToken = { get_access_token_logic_here };
+
+  const iTwinsResponse: AccessControlAPIResponse<Role> =
+    await accessControlClient.roles.getITwinRoleAsync(
+      accessToken,
+      "2f981e83-47e4-4f36-8ee9-4264453688a1",
+      "2d593231-db14-4c1f-9db4-96f2b91b0bde"
+    );
+
+  const actualRole = iTwinsResponse.data!;
+  console.log(actualRole.id, actualRole.displayName);
+}
+```
+
+### Create, update, and delete a Role
+
+```typescript
+import type { AccessToken } from "@itwin/core-bentley";
+import {
+  AccessControlClient,
+  IAccessControlClient,
+  Role,
+  AccessControlAPIResponse,
+} from "@itwin/access-control-client";
+
+/** Function that creates, updates, and deletes a role. */
+async function printiTwinRole(): Promise<void> {
+  const accessControlClient: IAccessControlClient = new AccessControlClient();
+  const accessToken: AccessToken = { get_access_token_logic_here };
+
+  // Create role
+  const createResponse: AccessControlAPIResponse<Role> =
+    await accessControlClient.roles.createITwinRoleAsync(
+      accessToken,
+      "71fd32ed-5ee4-4e22-bc4d-b8e973e0b7b7",
+      "d8215a6b-465d-44ff-910b-40d4541d1ebf"
+    );
+
+  // Update role
+  const updatedRole: Role = {
+    displayName: "Some new role name",
+    description: "UPDATED ROLE DESCRIPTION",
+    permissions: [],
+  };
+  const updateResponse: AccessControlAPIResponse<Role> =
+    await accessControlClient.roles.updateITwinRoleAsync(
+      accessToken,
+      "71fd32ed-5ee4-4e22-bc4d-b8e973e0b7b7",
+      createResponse.data!.id,
+      updatedRole
+    );
+
+  // Delete Role
+  const deleteResponse: AccessControlAPIResponse<undefined> =
+    await accessControlClient.roles.deleteITwinRoleAsync(
+      accessToken,
+      "71fd32ed-5ee4-4e22-bc4d-b8e973e0b7b7",
+      createResponse.data!.id
+    );
+}
+```
+
+### Get list of Members for an iTwin
+
+```typescript
+import type { AccessToken } from "@itwin/core-bentley";
+import {
+  AccessControlClient,
+  IAccessControlClient,
+  Member,
+  AccessControlAPIResponse,
+} from "@itwin/access-control-client";
+
+/** Function that queries all Members for a given iTwin and prints their ids to the console. */
+async function printiTwinMemberIds(): Promise<void> {
+  const accessControlClient: IAccessControlClient = new AccessControlClient();
+  const accessToken: AccessToken = { get_access_token_logic_here };
+
+  const iTwinsResponse: AccessControlAPIResponse<Member[]> =
+    await accessControlClient.members.queryITwinMembersAsync(
+      accessToken,
+      "9bd7d24d-1508-4dba-99ab-23b3166401a0"
+    );
+
+  iTwinsResponse.data!.forEach((actualMember: Member) => {
+    console.log(actualMember.id);
+  });
+}
+```
+
+### Get a filtered list of Members for an iTwin using $top/$skip
+
+```typescript
+import type { AccessToken } from "@itwin/core-bentley";
+import {
+  AccessControlClient,
+  IAccessControlClient,
+  Member,
+  AccessControlAPIResponse,
+} from "@itwin/access-control-client";
+
+/** Function that queries all Members for a given iTwin and prints their ids to the console. */
+async function printiTwinMemberIds(): Promise<void> {
+  const skipAmmount = 5;
+  const topAmount = 3;
+  const accessControlClient: IAccessControlClient = new AccessControlClient();
+  const accessToken: AccessToken = { get_access_token_logic_here };
+
+  const iTwinsResponse: AccessControlAPIResponse<Member[]> =
+    await accessControlClient.members.queryITwinMembersAsync(
+      accessToken,
+      "9bd7d24d-1508-4dba-99ab-23b3166401a0",
+      { skip: skipAmmount, top: topAmount }
+    );
+
+  iTwinsResponse.data!.forEach((actualMember: Member) => {
+    console.log(actualMember.id);
+  });
+}
+```
+
+### Get a specific Member of an iTwin
+
+```typescript
+import type { AccessToken } from "@itwin/core-bentley";
+import {
+  AccessControlClient,
+  IAccessControlClient,
+  Member,
+  AccessControlAPIResponse,
+} from "@itwin/access-control-client";
+
+/** Function that gets a member of an iTwin prints the id and email to the console. */
+async function printiTwinMemberIds(): Promise<void> {
+  const accessControlClient: IAccessControlClient = new AccessControlClient();
+  const accessToken: AccessToken = { get_access_token_logic_here };
+
+  const iTwinsResponse: AccessControlAPIResponse<Member> =
+    await accessControlClient.members.getITwinMemberAsync(
+      accessToken,
+      "9bd7d24d-1508-4dba-99ab-23b3166401a0",
+      "a083cc1c-f51a-4c52-8614-5774ab79eca1"
+    );
+
+  const actualMember = iTwinsResponse.data!;
+  console.log(actualMember.id, actualMember.email);
+}
+```
+
+### Create, update, and delete a Member
+
+```typescript
+import type { AccessToken } from "@itwin/core-bentley";
+import {
+  AccessControlClient,
+  IAccessControlClient,
+  Member,
+  AccessControlAPIResponse,
+} from "@itwin/access-control-client";
+
+/** Function that creates, updates, and deletes a member. */
+async function printiTwinRole(): Promise<void> {
+  const accessControlClient: IAccessControlClient = new AccessControlClient();
+  const accessToken: AccessToken = { get_access_token_logic_here };
+
+  // Create member
+  const createResponse: AccessControlAPIResponse<Role> =
+    await accessControlClient.members.addITwinMembersAsync(
+      accessToken,
+      "71fd32ed-5ee4-4e22-bc4d-b8e973e0b7b7",
+      "d8215a6b-465d-44ff-910b-40d4541d1ebf"
+    );
+
+  // Update member's role
+  const updatedMemberResponse: AccessControlAPIResponse<Member> =
+    await accessControlClient.members.updateITwinMemberAsync(
+      accessToken,
+      "b1803a0c-d440-4902-b527-54bf7f72500f",
+      "6401109c-75d7-46b8-8dbd-182d02155141",
+      [
+        "25162c0c-dce7-419e-bb51-fd13efd5b54a",
+        "10e3d778-0d35-4c4d-bf77-547bb366cb14",
+      ]
+    );
+
+  // Delete member
+  const removeMemberResponse: AccessControlAPIResponse<undefined> =
+    await accessControlClient.members.removeITwinMemberAsync(
+      accessToken,
+      "b1803a0c-d440-4902-b527-54bf7f72500f",
+      "6401109c-75d7-46b8-8dbd-182d02155141"
+    );
+}
+```
+
+### Get a list of Permissions
+
+```typescript
+import type { AccessToken } from "@itwin/core-bentley";
+import {
+  AccessControlClient,
+  IAccessControlClient,
+  Permission,
+  AccessControlAPIResponse,
+} from "@itwin/access-control-client";
+
+/** Function that queries all Permissions and prints the ids to the console. */
+async function printiTwinPermissionIds(): Promise<void> {
+  const accessControlClient: IAccessControlClient = new AccessControlClient();
+  const accessToken: AccessToken = { get_access_token_logic_here };
+
+  const iTwinsResponse: AccessControlAPIResponse<Permission[]> =
+    await accessControlClient.permissions.getPermissionsAsync(accessToken);
+
+  iTwinsResponse.data!.forEach((actualPermission: Permission) => {
+    console.log(actualPermission.id);
+  });
+}
+```
+
+### Get a list of Permissions for an iTwin
+
+```typescript
+import type { AccessToken } from "@itwin/core-bentley";
+import {
+  AccessControlClient,
+  IAccessControlClient,
+  Permission,
+  AccessControlAPIResponse,
+} from "@itwin/access-control-client";
+
+/** Function that queries Permissions for a given iTwin and prints the ids to the console. */
+async function printiTwinPermissionIds(): Promise<void> {
+  const accessControlClient: IAccessControlClient = new AccessControlClient();
+  const accessToken: AccessToken = { get_access_token_logic_here };
+
+  const iTwinsResponse: AccessControlAPIResponse<Permission[]> =
+    await accessControlClient.permissions.getITwinPermissionsAsync(
+      accessToken,
+      "6c704296-9028-4a1e-ae67-c0104a11402a"
+    );
+
+  iTwinsResponse.data!.forEach((actualPermission: Permission) => {
+    console.log(actualPermission.id);
+  });
+}
+```
 
 ## Contributing to this Repository
 

package/lib/cjs/AccessControlClient.d.ts

@@ -3,6 +3,8 @@
  */
 import type { IAccessControlClient, IMembersClient, IPermissionsClient, IRolesClient } from "./accessControlTypes";
 export declare class AccessControlClient implements IAccessControlClient {
+    private _baseUrl?;
+    constructor(url?: string);
     permissions: IPermissionsClient;
     roles: IRolesClient;
     members: IMembersClient;

package/lib/cjs/AccessControlClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AccessControlClient.d.ts","sourceRoot":"","sources":["../../src/AccessControlClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,oBAAoB,EAAE,cAAc,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAKnH,qBAAa,mBAAoB,YAAW,oBAAoB;IACvD,WAAW,EAAE,kBAAkB,CAA2B;IAC1D,KAAK,EAAE,YAAY,CAAqB;IACxC,OAAO,EAAE,cAAc,CAAuB;CACtD"}
+{"version":3,"file":"AccessControlClient.d.ts","sourceRoot":"","sources":["../../src/AccessControlClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,oBAAoB,EAAE,cAAc,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAKnH,qBAAa,mBAAoB,YAAW,oBAAoB;IAC9D,OAAO,CAAC,QAAQ,CAAC,CAAS;gBAEP,GAAG,CAAC,EAAE,MAAM;IAIxB,WAAW,EAAE,kBAAkB,CAAwC;IACvE,KAAK,EAAE,YAAY,CAAkC;IACrD,OAAO,EAAE,cAAc,CAAoC;CACnE"}

package/lib/cjs/AccessControlClient.js

@@ -5,10 +5,11 @@ const MembersClient_1 = require("./subClients/MembersClient");
 const PermissionsClient_1 = require("./subClients/PermissionsClient");
 const RolesClient_1 = require("./subClients/RolesClient");
 class AccessControlClient {
-    constructor() {
-        this.permissions = new PermissionsClient_1.PermissionsClient();
-        this.roles = new RolesClient_1.RolesClient();
-        this.members = new MembersClient_1.MembersClient();
+    constructor(url) {
+        this.permissions = new PermissionsClient_1.PermissionsClient(this._baseUrl);
+        this.roles = new RolesClient_1.RolesClient(this._baseUrl);
+        this.members = new MembersClient_1.MembersClient(this._baseUrl);
+        this._baseUrl = url;
     }
 }
 exports.AccessControlClient = AccessControlClient;

package/lib/cjs/AccessControlClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"AccessControlClient.js","sourceRoot":"","sources":["../../src/AccessControlClient.ts"],"names":[],"mappings":";;;AAQA,8DAA2D;AAC3D,sEAAmE;AACnE,0DAAuD;AAEvD,MAAa,mBAAmB;IAAhC;QACS,gBAAW,GAAuB,IAAI,qCAAiB,EAAE,CAAC;QAC1D,UAAK,GAAiB,IAAI,yBAAW,EAAE,CAAC;QACxC,YAAO,GAAmB,IAAI,6BAAa,EAAE,CAAC;IACvD,CAAC;CAAA;AAJD,kDAIC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module AccessControlClient\r\n */\r\nimport type { IAccessControlClient, IMembersClient, IPermissionsClient, IRolesClient } from \"./accessControlTypes\";\r\nimport { MembersClient } from \"./subClients/MembersClient\";\r\nimport { PermissionsClient } from \"./subClients/PermissionsClient\";\r\nimport { RolesClient } from \"./subClients/RolesClient\";\r\n\r\nexport class AccessControlClient implements IAccessControlClient {\r\n  public permissions: IPermissionsClient = new PermissionsClient();\r\n  public roles: IRolesClient = new RolesClient();\r\n  public members: IMembersClient = new MembersClient();\r\n}\r\n"]}
+{"version":3,"file":"AccessControlClient.js","sourceRoot":"","sources":["../../src/AccessControlClient.ts"],"names":[],"mappings":";;;AAQA,8DAA2D;AAC3D,sEAAmE;AACnE,0DAAuD;AAEvD,MAAa,mBAAmB;IAG9B,YAAmB,GAAY;QAIxB,gBAAW,GAAuB,IAAI,qCAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvE,UAAK,GAAiB,IAAI,yBAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrD,YAAO,GAAmB,IAAI,6BAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QALhE,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC;IACtB,CAAC;CAKF;AAVD,kDAUC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module AccessControlClient\r\n */\r\nimport type { IAccessControlClient, IMembersClient, IPermissionsClient, IRolesClient } from \"./accessControlTypes\";\r\nimport { MembersClient } from \"./subClients/MembersClient\";\r\nimport { PermissionsClient } from \"./subClients/PermissionsClient\";\r\nimport { RolesClient } from \"./subClients/RolesClient\";\r\n\r\nexport class AccessControlClient implements IAccessControlClient {\r\n  private _baseUrl?: string;\r\n\r\n  public constructor(url?: string){\r\n    this._baseUrl = url;\r\n  }\r\n\r\n  public permissions: IPermissionsClient = new PermissionsClient(this._baseUrl);\r\n  public roles: IRolesClient = new RolesClient(this._baseUrl);\r\n  public members: IMembersClient = new MembersClient(this._baseUrl);\r\n}\r\n"]}

package/lib/cjs/accessControlTypes.d.ts

@@ -19,7 +19,7 @@ export interface IMembersClient {
     /** Retrieves a specific member for a specified iTwin. */
     getITwinMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<Member>>;
     /** Add new iTwin members */
-    addITwinMembersAsync(accessToken: AccessToken, iTwinId: string, newMembers: NewMember[]): Promise<AccessControlAPIResponse<undefined>>;
+    addITwinMembersAsync(accessToken: AccessToken, iTwinId: string, newMembers: Member[]): Promise<AccessControlAPIResponse<undefined>>;
     /**  Remove the specified iTwin member */
     removeITwinMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>;
     /**  Update iTwin team member roles */
@@ -31,11 +31,11 @@ export interface IRolesClient {
     /** Retrieves a role for a specified iTwin */
     getITwinRoleAsync(accessToken: AccessToken, iTwinId: string, roleId: string): Promise<AccessControlAPIResponse<Role>>;
     /** Creates a new iTwin Role */
-    createITwinRoleAsync(accessToken: AccessToken, iTwinId: string, role: NewRole): Promise<AccessControlAPIResponse<Role>>;
+    createITwinRoleAsync(accessToken: AccessToken, iTwinId: string, role: Role): Promise<AccessControlAPIResponse<Role>>;
     /** Removes an existing iTwin Role */
     deleteITwinRoleAsync(accessToken: AccessToken, iTwinId: string, roleId: string): Promise<AccessControlAPIResponse<undefined>>;
     /** Updates an existing iTwin Role */
-    updateITwinRoleAsync(accessToken: AccessToken, iTwinId: string, roleId: string, role: NewRole): Promise<AccessControlAPIResponse<Role>>;
+    updateITwinRoleAsync(accessToken: AccessToken, iTwinId: string, roleId: string, role: Role): Promise<AccessControlAPIResponse<Role>>;
 }
 export interface AccessControlQueryArg {
     top?: number;
@@ -59,22 +59,18 @@ export interface ErrorDetail {
 }
 export declare type Permission = string;
 export interface Member {
-    id: string;
-    email: string;
-    givenName: string;
-    surname: string;
-    organization: string;
-    roles: Omit<Role, "permissions">[];
-}
-export interface NewMember {
-    email: string;
-    roleId: string;
+    id?: string;
+    roleid?: string;
+    email?: string;
+    givenName?: string;
+    surname?: string;
+    organization?: string;
+    roles?: Omit<Role, "permissions">[];
 }
 export interface Role {
-    id: string;
+    id?: string;
     displayName: string;
     description: string;
     permissions: Permission[];
 }
-export declare type NewRole = Omit<Role, "id">;
 //# sourceMappingURL=accessControlTypes.d.ts.map

package/lib/cjs/accessControlTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"accessControlTypes.d.ts","sourceRoot":"","sources":["../../src/accessControlTypes.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAEvD,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,kBAAkB,CAAC;IAChC,KAAK,EAAE,YAAY,CAAC;IACpB,OAAO,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC,uDAAuD;IACvD,mBAAmB,CACjB,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAEnD,6EAA6E;IAC7E,wBAAwB,CACtB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;CACpD;AAED,MAAM,WAAW,cAAc;IAC7B,sFAAsF;IACtF,sBAAsB,CACpB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,qBAAqB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE/C,yDAAyD;IACzD,mBAAmB,CACjB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC;IAE7C,4BAA4B;IAC5B,oBAAoB,CAClB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,SAAS,EAAE,GACtB,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,yCAAyC;IACzC,sBAAsB,CACpB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,sCAAsC;IACtC,sBAAsB,CACpB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,YAAY;IAC3B,0DAA0D;IAC1D,kBAAkB,CAChB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAE7C,6CAA6C;IAC7C,iBAAiB,CACf,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC;IAE3C,+BAA+B;IAC/B,oBAAoB,CAClB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,OAAO,GACZ,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC;IAE3C,qCAAqC;IACrC,oBAAoB,CAClB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,qCAAqC;IACrC,oBAAoB,CAClB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,OAAO,GACZ,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,qBAAqB;IACpC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB,CAAC,CAAC;IACzC,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,oBAAY,UAAU,GAAG,MAAM,CAAC;AAEhC,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B;AAED,oBAAY,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC"}
+{"version":3,"file":"accessControlTypes.d.ts","sourceRoot":"","sources":["../../src/accessControlTypes.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAEvD,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,kBAAkB,CAAC;IAChC,KAAK,EAAE,YAAY,CAAC;IACpB,OAAO,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC,uDAAuD;IACvD,mBAAmB,CACjB,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAEnD,6EAA6E;IAC7E,wBAAwB,CACtB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;CACpD;AAED,MAAM,WAAW,cAAc;IAC7B,sFAAsF;IACtF,sBAAsB,CACpB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,qBAAqB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE/C,yDAAyD;IACzD,mBAAmB,CACjB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC;IAE7C,4BAA4B;IAC5B,oBAAoB,CAClB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,yCAAyC;IACzC,sBAAsB,CACpB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,sCAAsC;IACtC,sBAAsB,CACpB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,YAAY;IAC3B,0DAA0D;IAC1D,kBAAkB,CAChB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAE7C,6CAA6C;IAC7C,iBAAiB,CACf,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC;IAE3C,+BAA+B;IAC/B,oBAAoB,CAClB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,IAAI,GACT,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC;IAE3C,qCAAqC;IACrC,oBAAoB,CAClB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,qCAAqC;IACrC,oBAAoB,CAClB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,GACT,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,qBAAqB;IACpC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB,CAAC,CAAC;IACzC,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,oBAAY,UAAU,GAAG,MAAM,CAAC;AAEhC,MAAM,WAAW,MAAM;IACrB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,IAAI;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B"}

package/lib/cjs/accessControlTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"accessControlTypes.js","sourceRoot":"","sources":["../../src/accessControlTypes.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module AccessControlClient\r\n */\r\n\r\nimport type { AccessToken } from \"@itwin/core-bentley\";\r\n\r\nexport interface IAccessControlClient {\r\n  permissions: IPermissionsClient;\r\n  roles: IRolesClient;\r\n  members: IMembersClient;\r\n}\r\n\r\nexport interface IPermissionsClient {\r\n  /** Retrieves the list of all available permissions **/\r\n  getPermissionsAsync(\r\n    accessToken: AccessToken,\r\n  ): Promise<AccessControlAPIResponse<Permission[]>>;\r\n\r\n  /** Retrieves a list of permissions the identity has for a specified iTwin */\r\n  getITwinPermissionsAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string\r\n  ): Promise<AccessControlAPIResponse<Permission[]>>;\r\n}\r\n\r\nexport interface IMembersClient{\r\n  /** Retrieves a list of team members and their roles assigned to a specified iTwin. */\r\n  queryITwinMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    arg?: AccessControlQueryArg\r\n  ): Promise<AccessControlAPIResponse<Member[]>>;\r\n\r\n  /** Retrieves a specific member for a specified iTwin. */\r\n  getITwinMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<Member>>;\r\n\r\n  /** Add new iTwin members */\r\n  addITwinMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    newMembers: NewMember[]\r\n  ): Promise<AccessControlAPIResponse<undefined>>;\r\n\r\n  /**  Remove the specified iTwin member */\r\n  removeITwinMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<undefined>>;\r\n\r\n  /**  Update iTwin team member roles */\r\n  updateITwinMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string,\r\n    roleIds: string[]\r\n  ): Promise<AccessControlAPIResponse<Member>>;\r\n}\r\n\r\nexport interface IRolesClient {\r\n  /** Retrieves a list of roles the for a specified iTwin */\r\n  getITwinRolesAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n  ): Promise<AccessControlAPIResponse<Role[]>>;\r\n\r\n  /** Retrieves a role for a specified iTwin */\r\n  getITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n  ): Promise<AccessControlAPIResponse<Role>>;\r\n\r\n  /** Creates a new iTwin Role */\r\n  createITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    role: NewRole\r\n  ): Promise<AccessControlAPIResponse<Role>>;\r\n\r\n  /** Removes an existing iTwin Role */\r\n  deleteITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n  ): Promise<AccessControlAPIResponse<undefined>>;\r\n\r\n  /** Updates an existing iTwin Role */\r\n  updateITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n    role: NewRole\r\n  ): Promise<AccessControlAPIResponse<Role>>;\r\n}\r\n\r\nexport interface AccessControlQueryArg {\r\n  top?: number;\r\n  skip?: number;\r\n}\r\n\r\nexport interface AccessControlAPIResponse<T> {\r\n  data?: T;\r\n  status: number;\r\n  error?: Error;\r\n}\r\n\r\nexport interface Error {\r\n  code: string;\r\n  message: string;\r\n  details?: ErrorDetail[];\r\n  target?: string;\r\n}\r\n\r\nexport interface ErrorDetail {\r\n  code: string;\r\n  message: string;\r\n  target?: string;\r\n}\r\n\r\nexport type Permission = string;\r\n\r\nexport interface Member {\r\n  id: string;\r\n  email: string;\r\n  givenName: string;\r\n  surname: string;\r\n  organization: string;\r\n  roles: Omit<Role, \"permissions\">[];\r\n}\r\n\r\nexport interface NewMember {\r\n  email: string;\r\n  roleId: string;\r\n}\r\n\r\nexport interface Role {\r\n  id: string;\r\n  displayName: string;\r\n  description: string;\r\n  permissions: Permission[];\r\n}\r\n\r\nexport type NewRole = Omit<Role, \"id\">;\r\n"]}
+{"version":3,"file":"accessControlTypes.js","sourceRoot":"","sources":["../../src/accessControlTypes.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module AccessControlClient\r\n */\r\n\r\nimport type { AccessToken } from \"@itwin/core-bentley\";\r\n\r\nexport interface IAccessControlClient {\r\n  permissions: IPermissionsClient;\r\n  roles: IRolesClient;\r\n  members: IMembersClient;\r\n}\r\n\r\nexport interface IPermissionsClient {\r\n  /** Retrieves the list of all available permissions **/\r\n  getPermissionsAsync(\r\n    accessToken: AccessToken,\r\n  ): Promise<AccessControlAPIResponse<Permission[]>>;\r\n\r\n  /** Retrieves a list of permissions the identity has for a specified iTwin */\r\n  getITwinPermissionsAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string\r\n  ): Promise<AccessControlAPIResponse<Permission[]>>;\r\n}\r\n\r\nexport interface IMembersClient{\r\n  /** Retrieves a list of team members and their roles assigned to a specified iTwin. */\r\n  queryITwinMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    arg?: AccessControlQueryArg\r\n  ): Promise<AccessControlAPIResponse<Member[]>>;\r\n\r\n  /** Retrieves a specific member for a specified iTwin. */\r\n  getITwinMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<Member>>;\r\n\r\n  /** Add new iTwin members */\r\n  addITwinMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    newMembers: Member[]\r\n  ): Promise<AccessControlAPIResponse<undefined>>;\r\n\r\n  /**  Remove the specified iTwin member */\r\n  removeITwinMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<undefined>>;\r\n\r\n  /**  Update iTwin team member roles */\r\n  updateITwinMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string,\r\n    roleIds: string[]\r\n  ): Promise<AccessControlAPIResponse<Member>>;\r\n}\r\n\r\nexport interface IRolesClient {\r\n  /** Retrieves a list of roles the for a specified iTwin */\r\n  getITwinRolesAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n  ): Promise<AccessControlAPIResponse<Role[]>>;\r\n\r\n  /** Retrieves a role for a specified iTwin */\r\n  getITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n  ): Promise<AccessControlAPIResponse<Role>>;\r\n\r\n  /** Creates a new iTwin Role */\r\n  createITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    role: Role\r\n  ): Promise<AccessControlAPIResponse<Role>>;\r\n\r\n  /** Removes an existing iTwin Role */\r\n  deleteITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n  ): Promise<AccessControlAPIResponse<undefined>>;\r\n\r\n  /** Updates an existing iTwin Role */\r\n  updateITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n    role: Role\r\n  ): Promise<AccessControlAPIResponse<Role>>;\r\n}\r\n\r\nexport interface AccessControlQueryArg {\r\n  top?: number;\r\n  skip?: number;\r\n}\r\n\r\nexport interface AccessControlAPIResponse<T> {\r\n  data?: T;\r\n  status: number;\r\n  error?: Error;\r\n}\r\n\r\nexport interface Error {\r\n  code: string;\r\n  message: string;\r\n  details?: ErrorDetail[];\r\n  target?: string;\r\n}\r\n\r\nexport interface ErrorDetail {\r\n  code: string;\r\n  message: string;\r\n  target?: string;\r\n}\r\n\r\nexport type Permission = string;\r\n\r\nexport interface Member {\r\n  id?: string;\r\n  roleid?: string;\r\n  email?: string;\r\n  givenName?: string;\r\n  surname?: string;\r\n  organization?: string;\r\n  roles?: Omit<Role, \"permissions\">[];\r\n}\r\n\r\nexport interface Role {\r\n  id?: string;\r\n  displayName: string;\r\n  description: string;\r\n  permissions: Permission[];\r\n}\r\n"]}

package/lib/cjs/subClients/BaseClient.d.ts

@@ -7,7 +7,7 @@ import type { AxiosRequestConfig } from "axios";
 import type { AccessControlAPIResponse, AccessControlQueryArg } from "../accessControlTypes";
 export declare class BaseClient {
     protected _baseUrl: string;
-    constructor();
+    constructor(url?: string);
     /**
       * Sends a basic API request
       * @param accessTokenString The client access token string

package/lib/cjs/subClients/BaseClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BaseClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/BaseClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAEhD,OAAO,KAAK,EAAE,wBAAwB,EAAE,qBAAqB,EAAC,MAAM,uBAAuB,CAAC;AAE5F,qBAAa,UAAU;IACrB,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAkD;;IAW5E;;;;;QAKI;cACY,qBAAqB,CACnC,WAAW,EAAE,WAAW,EACxB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,GAAG,EACV,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;IAuBzC;;;QAGI;IACJ,SAAS,CAAC,iBAAiB,CAAC,iBAAiB,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,kBAAkB;IAenH;;;;QAII;IACJ,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,qBAAqB,GAAG,MAAM;CAgBlE"}
+{"version":3,"file":"BaseClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/BaseClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAEhD,OAAO,KAAK,EAAE,wBAAwB,EAAE,qBAAqB,EAAC,MAAM,uBAAuB,CAAC;AAE5F,qBAAa,UAAU;IACrB,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAkD;gBAEzD,GAAG,CAAC,EAAE,MAAM;IAa/B;;;;;QAKI;cACY,qBAAqB,CACnC,WAAW,EAAE,WAAW,EACxB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,GAAG,EACV,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;IAuBzC;;;QAGI;IACJ,SAAS,CAAC,iBAAiB,CAAC,iBAAiB,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,kBAAkB;IAenH;;;;QAII;IACJ,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,qBAAqB,GAAG,MAAM;CAgBlE"}

package/lib/cjs/subClients/BaseClient.js

@@ -3,13 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseClient = void 0;
 const axios_1 = require("axios");
 class BaseClient {
-    constructor() {
+    constructor(url) {
         this._baseUrl = "https://api.bentley.com/accesscontrol/itwins";
-        const urlPrefix = process.env.IMJS_URL_PREFIX;
-        if (urlPrefix) {
-            const baseUrl = new URL(this._baseUrl);
-            baseUrl.hostname = urlPrefix + baseUrl.hostname;
-            this._baseUrl = baseUrl.href;
+        if (url !== undefined) {
+            this._baseUrl = url;
+        }
+        else {
+            const urlPrefix = process.env.IMJS_URL_PREFIX;
+            if (urlPrefix) {
+                const baseUrl = new URL(this._baseUrl);
+                baseUrl.hostname = urlPrefix + baseUrl.hostname;
+                this._baseUrl = baseUrl.href;
+            }
         }
     }
     /**