@itwin/access-control-client 1.2.0 → 2.0.0

package/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2022 Bentley Systems, Incorporated. All rights reserved.
+Copyright © 2022-2023 Bentley Systems, Incorporated. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/README.md

@@ -144,7 +144,7 @@ async function printiTwinRole(): Promise<void> {
 }
 ```
 
-### Get list of Members for an iTwin
+### Get list of User Members for an iTwin
 
 ```typescript
 import type { AccessToken } from "@itwin/core-bentley";
@@ -155,24 +155,24 @@ import {
   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> {
+/** Function that queries all User Members for a given iTwin and prints their ids to the console. */
+async function printiTwinUserMemberIds(): Promise<void> {
   const accessControlClient: IAccessControlClient = new AccessControlClient();
   const accessToken: AccessToken = { get_access_token_logic_here };
 
-  const iTwinsResponse: AccessControlAPIResponse<Member[]> =
-    await accessControlClient.members.queryITwinMembersAsync(
+  const iTwinsResponse: AccessControlAPIResponse<UserMember[]> =
+    await accessControlClient.userMembers.queryITwinUserMembersAsync(
       accessToken,
       "9bd7d24d-1508-4dba-99ab-23b3166401a0"
     );
 
-  iTwinsResponse.data!.forEach((actualMember: Member) => {
-    console.log(actualMember.id);
+  iTwinsResponse.data!.forEach((actualUserMember: UserMember) => {
+    console.log(actualUserMember.id);
   });
 }
 ```
 
-### Get a filtered list of Members for an iTwin using $top/$skip
+### Get a filtered list of User Members for an iTwin using $top/$skip
 
 ```typescript
 import type { AccessToken } from "@itwin/core-bentley";
@@ -183,27 +183,27 @@ import {
   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> {
+/** Function that queries all User Members for a given iTwin and prints their ids to the console. */
+async function printiTwinUserMemberIds(): 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(
+  const iTwinsResponse: AccessControlAPIResponse<UserMember[]> =
+    await accessControlClient.userMembers.queryITwinUserMembersAsync(
       accessToken,
       "9bd7d24d-1508-4dba-99ab-23b3166401a0",
       { skip: skipAmmount, top: topAmount }
     );
 
-  iTwinsResponse.data!.forEach((actualMember: Member) => {
-    console.log(actualMember.id);
+  iTwinsResponse.data!.forEach((actualUserMember: UserMember) => {
+    console.log(actualUserMember.id);
   });
 }
 ```
 
-### Get a specific Member of an iTwin
+### Get a specific User Member of an iTwin
 
 ```typescript
 import type { AccessToken } from "@itwin/core-bentley";
@@ -215,23 +215,23 @@ import {
 } 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> {
+async function printiTwinUserMemberIds(): Promise<void> {
   const accessControlClient: IAccessControlClient = new AccessControlClient();
   const accessToken: AccessToken = { get_access_token_logic_here };
 
-  const iTwinsResponse: AccessControlAPIResponse<Member> =
-    await accessControlClient.members.getITwinMemberAsync(
+  const iTwinsResponse: AccessControlAPIResponse<UserMember> =
+    await accessControlClient.userMembers.getITwinUserMemberAsync(
       accessToken,
       "9bd7d24d-1508-4dba-99ab-23b3166401a0",
       "a083cc1c-f51a-4c52-8614-5774ab79eca1"
     );
 
-  const actualMember = iTwinsResponse.data!;
-  console.log(actualMember.id, actualMember.email);
+  const actualUserMember = iTwinsResponse.data!;
+  console.log(actualUserMember.id, actualUserMember.email);
 }
 ```
 
-### Create, update, and delete a Member
+### Create, update, and delete an User Member
 
 ```typescript
 import type { AccessToken } from "@itwin/core-bentley";
@@ -242,22 +242,22 @@ import {
   AccessControlAPIResponse,
 } from "@itwin/access-control-client";
 
-/** Function that creates, updates, and deletes a member. */
+/** Function that creates, updates, and deletes a user member. */
 async function printiTwinRole(): Promise<void> {
   const accessControlClient: IAccessControlClient = new AccessControlClient();
   const accessToken: AccessToken = { get_access_token_logic_here };
 
-  // Create member
+  // Create user member
   const createResponse: AccessControlAPIResponse<Role> =
-    await accessControlClient.members.addITwinMembersAsync(
+    await accessControlClient.userMembers.addITwinUserMembersAsync(
       accessToken,
       "71fd32ed-5ee4-4e22-bc4d-b8e973e0b7b7",
       "d8215a6b-465d-44ff-910b-40d4541d1ebf"
     );
 
-  // Update member's role
-  const updatedMemberResponse: AccessControlAPIResponse<Member> =
-    await accessControlClient.members.updateITwinMemberAsync(
+  // Update user member's role
+  const updatedUserMemberResponse: AccessControlAPIResponse<UserMember> =
+    await accessControlClient.userMembers.updateITwinUserMemberAsync(
       accessToken,
       "b1803a0c-d440-4902-b527-54bf7f72500f",
       "6401109c-75d7-46b8-8dbd-182d02155141",
@@ -267,9 +267,276 @@ async function printiTwinRole(): Promise<void> {
       ]
     );
 
-  // Delete member
-  const removeMemberResponse: AccessControlAPIResponse<undefined> =
-    await accessControlClient.members.removeITwinMemberAsync(
+  // Delete user member
+  const removeUserMemberResponse: AccessControlAPIResponse<undefined> =
+    await accessControlClient.userMembers.removeITwinUserMemberAsync(
+      accessToken,
+      "b1803a0c-d440-4902-b527-54bf7f72500f",
+      "6401109c-75d7-46b8-8dbd-182d02155141"
+    );
+}
+```
+
+
+### Get list of Groups for an iTwin
+
+```typescript
+import type { AccessToken } from "@itwin/core-bentley";
+import {
+  AccessControlClient,
+  IAccessControlClient,
+  Group,
+  AccessControlAPIResponse,
+} from "@itwin/access-control-client";
+
+/** Function that queries all Groups for a given iTwin and prints their ids to the console. */
+async function printiTwinGroupIds(): Promise<void> {
+  const accessControlClient: IAccessControlClient = new AccessControlClient();
+  const accessToken: AccessToken = { get_access_token_logic_here };
+
+  const iTwinsResponse: AccessControlAPIResponse<Group[]> =
+    await accessControlClient.groups.getITwinGroupsAsync(
+      accessToken,
+      "2f981e83-47e4-4f36-8ee9-4264453688a1"
+    );
+
+  iTwinsResponse.data!.forEach((actualGroup: Group) => {
+    console.log(actualGroup.id);
+  });
+}
+```
+
+### Get list of Groups for an iTwin (with custom url)
+
+```typescript
+import type { AccessToken } from "@itwin/core-bentley";
+import {
+  AccessControlClient,
+  IAccessControlClient,
+  Group,
+  AccessControlAPIResponse,
+} from "@itwin/access-control-client";
+
+/** Function that queries all Groups for a given iTwin and prints their ids to the console. */
+async function printiTwinGroupIds(): Promise<void> {
+  const accessControlClient: IAccessControlClient = new AccessControlClient("https://api.bentley.com/accesscontrol/itwins");
+  const accessToken: AccessToken = { get_access_token_logic_here };
+
+  const iTwinsResponse: AccessControlAPIResponse<Group[]> =
+    await accessControlClient.groups.getITwinGroupsAsync(
+      accessToken,
+      "2f981e83-47e4-4f36-8ee9-4264453688a1"
+    );
+
+  iTwinsResponse.data!.forEach((actualGroup: Group) => {
+    console.log(actualGroup.id);
+  });
+}
+```
+
+### Get specific Group for an iTwin
+
+```typescript
+import type { AccessToken } from "@itwin/core-bentley";
+import {
+  AccessControlClient,
+  IAccessControlClient,
+  Group,
+  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 printiTwinGroup(): Promise<void> {
+  const accessControlClient: IAccessControlClient = new AccessControlClient();
+  const accessToken: AccessToken = { get_access_token_logic_here };
+
+  const iTwinsResponse: AccessControlAPIResponse<Group> =
+    await accessControlClient.groups.getITwinGroupAsync(
+      accessToken,
+      "2f981e83-47e4-4f36-8ee9-4264453688a1",
+      "2d593231-db14-4c1f-9db4-96f2b91b0bde"
+    );
+
+  const actualGroup = iTwinsResponse.data!;
+  console.log(actualGroup.id, actualGroup.displayName);
+}
+```
+
+### Create, update, and delete a Group
+
+```typescript
+import type { AccessToken } from "@itwin/core-bentley";
+import {
+  AccessControlClient,
+  IAccessControlClient,
+  Group,
+  AccessControlAPIResponse,
+} from "@itwin/access-control-client";
+
+/** Function that creates, updates, and deletes a role. */
+async function printiTwinGroup(): Promise<void> {
+  const accessControlClient: IAccessControlClient = new AccessControlClient();
+  const accessToken: AccessToken = { get_access_token_logic_here };
+
+  // Create role
+  const createResponse: AccessControlAPIResponse<Group> =
+    await accessControlClient.groups.createITwinGroupAsync(
+      accessToken,
+      "71fd32ed-5ee4-4e22-bc4d-b8e973e0b7b7",
+      "d8215a6b-465d-44ff-910b-40d4541d1ebf"
+    );
+
+  // Update role
+  const updatedGroup: Group = {
+    name: "Some new group name",
+    description: "UPDATED GROUP DESCRIPTION",
+    user: ["John.Johnson@example.com"],
+    imsGroups: ["Sample IMS Group"]
+  };
+  const updateResponse: AccessControlAPIResponse<Group> =
+    await accessControlClient.groups.updateITwinGroupAsync(
+      accessToken,
+      "71fd32ed-5ee4-4e22-bc4d-b8e973e0b7b7",
+      createResponse.data!.id,
+      updatedGroup
+    );
+
+  // Delete Group
+  const deleteResponse: AccessControlAPIResponse<undefined> =
+    await accessControlClient.groups.deleteITwinGRoupAsync(
+      accessToken,
+      "71fd32ed-5ee4-4e22-bc4d-b8e973e0b7b7",
+      createResponse.data!.id
+    );
+}
+```
+
+### Get list of Group 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 User Members for a given iTwin and prints their ids to the console. */
+async function printiTwinGroupMemberIds(): Promise<void> {
+  const accessControlClient: IAccessControlClient = new AccessControlClient();
+  const accessToken: AccessToken = { get_access_token_logic_here };
+
+  const iTwinsResponse: AccessControlAPIResponse<GroupMember[]> =
+    await accessControlClient.groupMembers.queryITwinGroupMembersAsync(
+      accessToken,
+      "9bd7d24d-1508-4dba-99ab-23b3166401a0"
+    );
+
+  iTwinsResponse.data!.forEach((actualGroupMember: GroupMember) => {
+    console.log(actualGroupMember.id);
+  });
+}
+```
+
+### Get a filtered list of Group 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 User Members for a given iTwin and prints their ids to the console. */
+async function printiTwinGroupMemberIds(): Promise<void> {
+  const skipAmmount = 5;
+  const topAmount = 3;
+  const accessControlClient: IAccessControlClient = new AccessControlClient();
+  const accessToken: AccessToken = { get_access_token_logic_here };
+
+  const iTwinsResponse: AccessControlAPIResponse<GroupMember[]> =
+    await accessControlClient.groupMembers.queryITwinGroupMembersAsync(
+      accessToken,
+      "9bd7d24d-1508-4dba-99ab-23b3166401a0",
+      { skip: skipAmmount, top: topAmount }
+    );
+
+  iTwinsResponse.data!.forEach((actualGroupMember: GroupMember) => {
+    console.log(actualGroupMember.id);
+  });
+}
+```
+
+### Get a specific Group 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 printiTwinGroupMemberIds(): Promise<void> {
+  const accessControlClient: IAccessControlClient = new AccessControlClient();
+  const accessToken: AccessToken = { get_access_token_logic_here };
+
+  const iTwinsResponse: AccessControlAPIResponse<GroupMember> =
+    await accessControlClient.groupMembers.getITwinGroupMemberAsync(
+      accessToken,
+      "9bd7d24d-1508-4dba-99ab-23b3166401a0",
+      "a083cc1c-f51a-4c52-8614-5774ab79eca1"
+    );
+
+  const actualGroupMember = iTwinsResponse.data!;
+  console.log(actualGroupMember.id, actualGroupMember.email);
+}
+```
+
+### Create, update, and delete a Group 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 user member. */
+async function printiTwinRole(): Promise<void> {
+  const accessControlClient: IAccessControlClient = new AccessControlClient();
+  const accessToken: AccessToken = { get_access_token_logic_here };
+
+  // Create user member
+  const createResponse: AccessControlAPIResponse<Role> =
+    await accessControlClient.groupMembers.addITwinGroupMembersAsync(
+      accessToken,
+      "71fd32ed-5ee4-4e22-bc4d-b8e973e0b7b7",
+      "d8215a6b-465d-44ff-910b-40d4541d1ebf"
+    );
+
+  // Update user member's role
+  const updatedGroupMemberResponse: AccessControlAPIResponse<GroupMember> =
+    await accessControlClient.groupMembers.updateITwinGroupMemberAsync(
+      accessToken,
+      "b1803a0c-d440-4902-b527-54bf7f72500f",
+      "6401109c-75d7-46b8-8dbd-182d02155141",
+      [
+        "25162c0c-dce7-419e-bb51-fd13efd5b54a",
+        "10e3d778-0d35-4c4d-bf77-547bb366cb14",
+      ]
+    );
+
+  // Delete user member
+  const removeGroupMemberResponse: AccessControlAPIResponse<undefined> =
+    await accessControlClient.groupMembers.removeITwinGroupMemberAsync(
       accessToken,
       "b1803a0c-d440-4902-b527-54bf7f72500f",
       "6401109c-75d7-46b8-8dbd-182d02155141"

package/lib/cjs/AccessControlClient.d.ts

@@ -1,11 +1,13 @@
 /** @packageDocumentation
  * @module AccessControlClient
  */
-import type { IAccessControlClient, IMembersClient, IPermissionsClient, IRolesClient } from "./accessControlTypes";
+import type { IAccessControlClient, IGroupMembersClient, IGroupsClient, IPermissionsClient, IRolesClient, IUserMembersClient } from "./accessControlTypes";
 export declare class AccessControlClient implements IAccessControlClient {
     permissions: IPermissionsClient;
     roles: IRolesClient;
-    members: IMembersClient;
+    groups: IGroupsClient;
+    userMembers: IUserMembersClient;
+    groupMembers: IGroupMembersClient;
     constructor(url?: string);
 }
 //# sourceMappingURL=AccessControlClient.d.ts.map

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,CAAC;IAChC,KAAK,EAAE,YAAY,CAAC;IACpB,OAAO,EAAE,cAAc,CAAC;gBAEZ,GAAG,CAAC,EAAE,MAAM;CAKhC"}
+{"version":3,"file":"AccessControlClient.d.ts","sourceRoot":"","sources":["../../src/AccessControlClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EACV,oBAAoB,EACpB,mBAAmB,EACnB,aAAa,EACb,kBAAkB,EAClB,YAAY,EACZ,kBAAkB,EACnB,MAAM,sBAAsB,CAAC;AAO9B,qBAAa,mBAAoB,YAAW,oBAAoB;IACvD,WAAW,EAAE,kBAAkB,CAAC;IAChC,KAAK,EAAE,YAAY,CAAC;IACpB,MAAM,EAAE,aAAa,CAAC;IACtB,WAAW,EAAE,kBAAkB,CAAC;IAChC,YAAY,EAAE,mBAAmB,CAAC;gBAEtB,GAAG,CAAC,EAAE,MAAM;CAOhC"}

package/lib/cjs/AccessControlClient.js

@@ -1,14 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AccessControlClient = void 0;
-const MembersClient_1 = require("./subClients/MembersClient");
 const PermissionsClient_1 = require("./subClients/PermissionsClient");
 const RolesClient_1 = require("./subClients/RolesClient");
+const GroupsClient_1 = require("./subClients/GroupsClient");
+const UserMembersClient_1 = require("./subClients/UserMembersClient");
+const GroupMembersClient_1 = require("./subClients/GroupMembersClient");
 class AccessControlClient {
     constructor(url) {
         this.permissions = new PermissionsClient_1.PermissionsClient(url);
         this.roles = new RolesClient_1.RolesClient(url);
-        this.members = new MembersClient_1.MembersClient(url);
+        this.groups = new GroupsClient_1.GroupsClient(url);
+        this.userMembers = new UserMembersClient_1.UserMembersClient(url);
+        this.groupMembers = new GroupMembersClient_1.GroupMembersClient(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;IAK9B,YAAmB,GAAY;QAC7B,IAAI,CAAC,WAAW,GAAG,IAAI,qCAAiB,CAAC,GAAG,CAAC,CAAC;QAC9C,IAAI,CAAC,KAAK,GAAG,IAAI,yBAAW,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,CAAC,OAAO,GAAG,IAAI,6BAAa,CAAC,GAAG,CAAC,CAAC;IACxC,CAAC;CACF;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  public permissions: IPermissionsClient;\r\n  public roles: IRolesClient;\r\n  public members: IMembersClient;\r\n\r\n  public constructor(url?: string){\r\n    this.permissions = new PermissionsClient(url);\r\n    this.roles = new RolesClient(url);\r\n    this.members = new MembersClient(url);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"AccessControlClient.js","sourceRoot":"","sources":["../../src/AccessControlClient.ts"],"names":[],"mappings":";;;AAeA,sEAAmE;AACnE,0DAAuD;AACvD,4DAAyD;AACzD,sEAAmE;AACnE,wEAAqE;AAErE,MAAa,mBAAmB;IAO9B,YAAmB,GAAY;QAC7B,IAAI,CAAC,WAAW,GAAG,IAAI,qCAAiB,CAAC,GAAG,CAAC,CAAC;QAC9C,IAAI,CAAC,KAAK,GAAG,IAAI,yBAAW,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,CAAC,MAAM,GAAG,IAAI,2BAAY,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,IAAI,qCAAiB,CAAC,GAAG,CAAC,CAAC;QAC9C,IAAI,CAAC,YAAY,GAAG,IAAI,uCAAkB,CAAC,GAAG,CAAC,CAAC;IAClD,CAAC;CACF;AAdD,kDAcC","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 {\r\n  IAccessControlClient,\r\n  IGroupMembersClient,\r\n  IGroupsClient,\r\n  IPermissionsClient,\r\n  IRolesClient,\r\n  IUserMembersClient,\r\n} from \"./accessControlTypes\";\r\nimport { PermissionsClient } from \"./subClients/PermissionsClient\";\r\nimport { RolesClient } from \"./subClients/RolesClient\";\r\nimport { GroupsClient } from \"./subClients/GroupsClient\";\r\nimport { UserMembersClient } from \"./subClients/UserMembersClient\";\r\nimport { GroupMembersClient } from \"./subClients/GroupMembersClient\";\r\n\r\nexport class AccessControlClient implements IAccessControlClient {\r\n  public permissions: IPermissionsClient;\r\n  public roles: IRolesClient;\r\n  public groups: IGroupsClient;\r\n  public userMembers: IUserMembersClient;\r\n  public groupMembers: IGroupMembersClient;\r\n\r\n  public constructor(url?: string) {\r\n    this.permissions = new PermissionsClient(url);\r\n    this.roles = new RolesClient(url);\r\n    this.groups = new GroupsClient(url);\r\n    this.userMembers = new UserMembersClient(url);\r\n    this.groupMembers = new GroupMembersClient(url);\r\n  }\r\n}\r\n"]}

package/lib/cjs/accessControlTypes.d.ts

@@ -5,7 +5,9 @@ import type { AccessToken } from "@itwin/core-bentley";
 export interface IAccessControlClient {
     permissions: IPermissionsClient;
     roles: IRolesClient;
-    members: IMembersClient;
+    groups: IGroupsClient;
+    userMembers: IUserMembersClient;
+    groupMembers: IGroupMembersClient;
 }
 export interface IPermissionsClient {
     /** Retrieves the list of all available permissions **/
@@ -13,17 +15,29 @@ export interface IPermissionsClient {
     /** Retrieves a list of permissions the identity has for a specified iTwin */
     getITwinPermissionsAsync(accessToken: AccessToken, iTwinId: string): Promise<AccessControlAPIResponse<Permission[]>>;
 }
-export interface IMembersClient {
-    /** Retrieves a list of team members and their roles assigned to a specified iTwin. */
-    queryITwinMembersAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<Member[]>>;
-    /** 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: Member[]): Promise<AccessControlAPIResponse<Member[]>>;
-    /**  Remove the specified iTwin member */
-    removeITwinMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>;
-    /**  Update iTwin team member roles */
-    updateITwinMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<AccessControlAPIResponse<Member>>;
+export interface IUserMembersClient {
+    /** Retrieves a list of user members and their roles assigned to a specified iTwin. */
+    queryITwinUserMembersAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<UserMember[]>>;
+    /** Retrieves a specific user member for a specified iTwin. */
+    getITwinUserMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<UserMember>>;
+    /** Add new iTwin user members */
+    addITwinUserMembersAsync(accessToken: AccessToken, iTwinId: string, newMembers: UserMember[]): Promise<AccessControlAPIResponse<UserMember[]>>;
+    /**  Remove the specified iTwin user member */
+    removeITwinUserMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>;
+    /**  Update iTwin user member roles */
+    updateITwinUserMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<AccessControlAPIResponse<UserMember>>;
+}
+export interface IGroupMembersClient {
+    /** Retrieves a list of group members and their roles assigned to a specified iTwin. */
+    queryITwinGroupMembersAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<GroupMember[]>>;
+    /** Retrieves a specific group member for a specified iTwin. */
+    getITwinGroupMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<GroupMember>>;
+    /** Add new iTwin group members */
+    addITwinGroupMembersAsync(accessToken: AccessToken, iTwinId: string, newMembers: GroupMember[]): Promise<AccessControlAPIResponse<GroupMember[]>>;
+    /**  Remove the specified iTwin group member */
+    removeITwinGroupMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>;
+    /**  Update iTwin group member roles */
+    updateITwinGroupMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<AccessControlAPIResponse<GroupMember>>;
 }
 export interface IRolesClient {
     /** Retrieves a list of roles the for a specified iTwin */
@@ -37,6 +51,18 @@ export interface IRolesClient {
     /** Updates an existing iTwin Role */
     updateITwinRoleAsync(accessToken: AccessToken, iTwinId: string, roleId: string, role: Role): Promise<AccessControlAPIResponse<Role>>;
 }
+export interface IGroupsClient {
+    /** Retrieves a list of groups the for a specified iTwin */
+    getITwinGroupsAsync(accessToken: AccessToken, iTwinId: string): Promise<AccessControlAPIResponse<Group[]>>;
+    /** Retrieves a group for a specified iTwin */
+    getITwinGroupAsync(accessToken: AccessToken, iTwinId: string, groupId: string): Promise<AccessControlAPIResponse<Group>>;
+    /** Creates a new iTwin group */
+    createITwinGroupAsync(accessToken: AccessToken, iTwinId: string, group: Group): Promise<AccessControlAPIResponse<Group>>;
+    /** Removes an existing iTwin group */
+    deleteITwinGroupAsync(accessToken: AccessToken, iTwinId: string, groupId: string): Promise<AccessControlAPIResponse<undefined>>;
+    /** Updates an existing iTwin group */
+    updateITwinGroupAsync(accessToken: AccessToken, iTwinId: string, groupId: string, group: Group): Promise<AccessControlAPIResponse<Group>>;
+}
 export interface AccessControlQueryArg {
     top?: number;
     skip?: number;
@@ -58,7 +84,7 @@ export interface ErrorDetail {
     target?: string;
 }
 export declare type Permission = string;
-export interface Member {
+export interface UserMember {
     id?: string;
     roleid?: string;
     email?: string;
@@ -67,10 +93,23 @@ export interface Member {
     organization?: string;
     roles?: Omit<Role, "permissions">[];
 }
+export interface GroupMember {
+    id?: string;
+    groupName?: string;
+    groupDescription?: string;
+    roles?: Omit<Role, "permissions">[];
+}
 export interface Role {
     id?: string;
     displayName: string;
     description: string;
     permissions: Permission[];
 }
+export interface Group {
+    id?: string;
+    name?: string;
+    description?: string;
+    users?: string[];
+    imsGroups?: string[];
+}
 //# 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,MAAM,EAAE,GACnB,OAAO,CAAC,wBAAwB,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE/C,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"}
+{"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,MAAM,EAAE,aAAa,CAAC;IACtB,WAAW,EAAE,kBAAkB,CAAC;IAChC,YAAY,EAAE,mBAAmB,CAAC;CACnC;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,kBAAkB;IACjC,sFAAsF;IACtF,0BAA0B,CACxB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,qBAAqB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAEnD,8DAA8D;IAC9D,uBAAuB,CACrB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,CAAC;IAEjD,iCAAiC;IACjC,wBAAwB,CACtB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,UAAU,EAAE,GACvB,OAAO,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAEnD,8CAA8C;IAC9C,0BAA0B,CACxB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,sCAAsC;IACtC,0BAA0B,CACxB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,mBAAmB;IAClC,uFAAuF;IACvF,2BAA2B,CACzB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,qBAAqB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAEpD,+DAA+D;IAC/D,wBAAwB,CACtB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,WAAW,CAAC,CAAC,CAAC;IAElD,kCAAkC;IAClC,yBAAyB,CACvB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,WAAW,EAAE,GACxB,OAAO,CAAC,wBAAwB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAEpD,+CAA+C;IAC/C,2BAA2B,CACzB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,uCAAuC;IACvC,2BAA2B,CACzB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,wBAAwB,CAAC,WAAW,CAAC,CAAC,CAAC;CACnD;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,aAAa;IAC5B,2DAA2D;IAC3D,mBAAmB,CACjB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAE9C,8CAA8C;IAC9C,kBAAkB,CAChB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC;IAE5C,gCAAgC;IAChC,qBAAqB,CACnB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,KAAK,GACX,OAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC;IAE5C,sCAAsC;IACtC,qBAAqB,CACnB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,sCAAsC;IACtC,qBAAqB,CACnB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,KAAK,GACX,OAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC;CAC7C;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,UAAU;IACzB,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,WAAW;IAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,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;AAED,MAAM,WAAW,KAAK;IACpB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB"}

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: Member[]\r\n  ): Promise<AccessControlAPIResponse<Member[]>>;\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"]}
+{"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  groups: IGroupsClient;\r\n  userMembers: IUserMembersClient;\r\n  groupMembers: IGroupMembersClient;\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 IUserMembersClient {\r\n  /** Retrieves a list of user members and their roles assigned to a specified iTwin. */\r\n  queryITwinUserMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    arg?: AccessControlQueryArg\r\n  ): Promise<AccessControlAPIResponse<UserMember[]>>;\r\n\r\n  /** Retrieves a specific user member for a specified iTwin. */\r\n  getITwinUserMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<UserMember>>;\r\n\r\n  /** Add new iTwin user members */\r\n  addITwinUserMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    newMembers: UserMember[]\r\n  ): Promise<AccessControlAPIResponse<UserMember[]>>;\r\n\r\n  /**  Remove the specified iTwin user member */\r\n  removeITwinUserMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<undefined>>;\r\n\r\n  /**  Update iTwin user member roles */\r\n  updateITwinUserMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string,\r\n    roleIds: string[]\r\n  ): Promise<AccessControlAPIResponse<UserMember>>;\r\n}\r\n\r\nexport interface IGroupMembersClient {\r\n  /** Retrieves a list of group members and their roles assigned to a specified iTwin. */\r\n  queryITwinGroupMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    arg?: AccessControlQueryArg\r\n  ): Promise<AccessControlAPIResponse<GroupMember[]>>;\r\n\r\n  /** Retrieves a specific group member for a specified iTwin. */\r\n  getITwinGroupMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<GroupMember>>;\r\n\r\n  /** Add new iTwin group members */\r\n  addITwinGroupMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    newMembers: GroupMember[]\r\n  ): Promise<AccessControlAPIResponse<GroupMember[]>>;\r\n\r\n  /**  Remove the specified iTwin group member */\r\n  removeITwinGroupMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<undefined>>;\r\n\r\n  /**  Update iTwin group member roles */\r\n  updateITwinGroupMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string,\r\n    roleIds: string[]\r\n  ): Promise<AccessControlAPIResponse<GroupMember>>;\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 IGroupsClient {\r\n  /** Retrieves a list of groups the for a specified iTwin */\r\n  getITwinGroupsAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string\r\n  ): Promise<AccessControlAPIResponse<Group[]>>;\r\n\r\n  /** Retrieves a group for a specified iTwin */\r\n  getITwinGroupAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    groupId: string\r\n  ): Promise<AccessControlAPIResponse<Group>>;\r\n\r\n  /** Creates a new iTwin group */\r\n  createITwinGroupAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    group: Group\r\n  ): Promise<AccessControlAPIResponse<Group>>;\r\n\r\n  /** Removes an existing iTwin group */\r\n  deleteITwinGroupAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    groupId: string\r\n  ): Promise<AccessControlAPIResponse<undefined>>;\r\n\r\n  /** Updates an existing iTwin group */\r\n  updateITwinGroupAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    groupId: string,\r\n    group: Group\r\n  ): Promise<AccessControlAPIResponse<Group>>;\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 UserMember {\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 GroupMember {\r\n  id?: string;\r\n  groupName?: string;\r\n  groupDescription?: 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\r\nexport interface Group {\r\n  id?: string;\r\n  name?: string;\r\n  description?: string;\r\n  users?: string[];\r\n  imsGroups?: string[];\r\n}\r\n"]}

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;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"}
+{"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;IAgBnH;;;;QAII;IACJ,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,qBAAqB,GAAG,MAAM;CAgBlE"}

package/lib/cjs/subClients/BaseClient.js

@@ -55,6 +55,7 @@ class BaseClient {
             headers: {
                 "authorization": accessTokenString,
                 "content-type": "application/json",
+                "accept": "application/vnd.bentley.itwin-platform.v2+json",
             },
             validateStatus(status) {
                 return status < 500; // Resolve only if the status code is less than 500