@itwin/access-control-client 3.6.0 → 4.0.0

package/README.md

@@ -1,747 +1,225 @@
 # Access Control Client Library
 
-Copyright © Bentley Systems, Incorporated. All rights reserved. See [LICENSE.md](./LICENSE.md) for license terms and full copyright notice.
+[![npm version](https://badge.fury.io/js/@itwin%2Faccess-control-client.svg)](https://badge.fury.io/js/@itwin%2Faccess-control-client)
 
-[iTwin.js](http://www.itwinjs.org) is an open source platform for creating, querying, modifying, and displaying Infrastructure Digital Twins. To learn more about the iTwin Platform and its APIs, visit the [iTwin developer portal](https://developer.bentley.com/).
+A comprehensive TypeScript library for Bentley Systems' Access Control API, providing type-safe access to iTwin access management, roles, permissions, groups, and member operations.
 
-If you have questions, or wish to contribute to iTwin.js, see our [Contributing guide](./CONTRIBUTING.md).
+## Table of Contents
 
-## About this Repository
-
-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.
+- [Quick Start](#quick-start)
+- [Installation](#installation)
+- [Basic Usage](#basic-usage)
+- [Documentation](#documentation)
+- [API Reference](#api-reference)
+- [About this Repository](#about-this-repository)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
 
-## Usage examples
+## Quick Start
 
-### Get list of Roles for an iTwin
+Get up and running with Access Control Client in just a few steps:
 
-```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);
-  });
-}
+```bash
+npm install @itwin/access-control-client
 ```
 
-### 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";
+import { AccessControlClient } 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);
-  });
-}
+const client = new AccessControlClient();
+const accessToken = "your-access-token-string";
+const roles = await client.roles.getITwinRoles(accessToken, "itwin-id");
+console.log(`Found ${roles.data!.length} roles`);
 ```
 
-### Get specific role for an iTwin
+## Installation
 
-```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);
-}
-```
+```bash
+# Using npm
+npm install @itwin/access-control-client
 
-### Create, update, and delete a Role
-
-```typescript
-import type { AccessToken } from "@itwin/core-bentley";
-import {
-  AccessControlClient,
-  IAccessControlClient,
-  Role,
-  AccessControlAPIResponse,
-} from "@itwin/access-control-client";
+# Using yarn
+yarn add @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
-    );
-}
+# Using pnpm
+pnpm add @itwin/access-control-client
 ```
 
-### Get list of User Members for an iTwin
+## Basic Usage
 
-```typescript
-import type { AccessToken } from "@itwin/core-bentley";
-import {
-  AccessControlClient,
-  IAccessControlClient,
-  Member,
-  AccessControlAPIResponse,
-} from "@itwin/access-control-client";
+### Authentication
 
-/** 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<UserMember[]> =
-    await accessControlClient.userMembers.queryITwinUserMembersAsync(
-      accessToken,
-      "9bd7d24d-1508-4dba-99ab-23b3166401a0"
-    );
-
-  iTwinsResponse.data!.forEach((actualUserMember: UserMember) => {
-    console.log(actualUserMember.id);
-  });
-}
-```
+All API methods require an access token string. See the [iTwin Platform documentation](https://developer.bentley.com/tutorials/create-and-query-itwins-guide/#1-register-an-application) for authentication setup.
 
-### Get a filtered list of User Members for an iTwin using $top/$skip
+### Environment Configuration
 
-```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 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<UserMember[]> =
-    await accessControlClient.userMembers.queryITwinUserMembersAsync(
-      accessToken,
-      "9bd7d24d-1508-4dba-99ab-23b3166401a0",
-      { skip: skipAmmount, top: topAmount }
-    );
-
-  iTwinsResponse.data!.forEach((actualUserMember: UserMember) => {
-    console.log(actualUserMember.id);
-  });
-}
-```
-
-### Get a specific User Member of an iTwin
+Configure different deployment environments using `globalThis.IMJS_URL_PREFIX`:
 
 ```typescript
-import type { AccessToken } from "@itwin/core-bentley";
-import {
-  AccessControlClient,
-  IAccessControlClient,
-  Member,
-  AccessControlAPIResponse,
-} from "@itwin/access-control-client";
+// Development environment
+globalThis.IMJS_URL_PREFIX = "dev-";
 
-/** Function that gets a member of an iTwin prints the id and email to the console. */
-async function printiTwinUserMemberIds(): Promise<void> {
-  const accessControlClient: IAccessControlClient = new AccessControlClient();
-  const accessToken: AccessToken = { get_access_token_logic_here };
-
-  const iTwinsResponse: AccessControlAPIResponse<UserMember> =
-    await accessControlClient.userMembers.getITwinUserMemberAsync(
-      accessToken,
-      "9bd7d24d-1508-4dba-99ab-23b3166401a0",
-      "a083cc1c-f51a-4c52-8614-5774ab79eca1"
-    );
-
-  const actualUserMember = iTwinsResponse.data!;
-  console.log(actualUserMember.id, actualUserMember.email);
-}
+// QA environment
+globalThis.IMJS_URL_PREFIX = "qa-";
+
+// Production (default)
+globalThis.IMJS_URL_PREFIX = undefined;
 ```
 
-### Create, update, and delete an User Member
+## Documentation
 
-```typescript
-import type { AccessToken } from "@itwin/core-bentley";
-import {
-  AccessControlClient,
-  IAccessControlClient,
-  Member,
-  AccessControlAPIResponse,
-} from "@itwin/access-control-client";
+### Core Documentation
 
-/** 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.userMembers.addITwinUserMembersAsync(
-      accessToken,
-      "71fd32ed-5ee4-4e22-bc4d-b8e973e0b7b7",
-      [
-          {
-            email: "user@example.com",
-            roleIds: ["d8215a6b-465d-44ff-910b-40d4541d1ebf"],
-          },
-      ],
-      "Example custom message"
-    );
-
-  // Update user member's role
-  const updatedUserMemberResponse: AccessControlAPIResponse<UserMember> =
-    await accessControlClient.userMembers.updateITwinUserMemberAsync(
-      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 removeUserMemberResponse: AccessControlAPIResponse<undefined> =
-    await accessControlClient.userMembers.removeITwinUserMemberAsync(
-      accessToken,
-      "b1803a0c-d440-4902-b527-54bf7f72500f",
-      "6401109c-75d7-46b8-8dbd-182d02155141"
-    );
-}
-```
+| Document | Purpose |
+|----------|---------|
+| **[Getting Started Guide](./GETTINGSTARTED.md)** | Complete setup and first steps |
+| **[Migration Guide v3→v4](./MIGRATION-GUIDE-v3-to-v4.md)** | Upgrading from v3.x to v4.x |
+| **[Contributing Guide](./CONTRIBUTING.md)** | Development and contribution workflow |
 
-### Get list of Owner Members for an iTwin
+## API Reference
 
-```typescript
-import type { AccessToken } from "@itwin/core-bentley";
-import {
-  AccessControlClient,
-  IAccessControlClient,
-  OwnerMember,
-  AccessControlAPIResponse,
-} from "@itwin/access-control-client";
+### Core Classes
 
-/** Function that queries all Owner Members for a given iTwin and prints their ids to the console. */
-async function printiTwinOwnerMemberIds(): Promise<void> {
-  const accessControlClient: IAccessControlClient = new AccessControlClient();
-  const accessToken: AccessToken = { get_access_token_logic_here };
-
-  const iTwinsResponse: AccessControlAPIResponse<OwnerMember[]> =
-    await accessControlClient.ownerMembers.queryITwinOwnerMembersAsync(
-      accessToken,
-      "9bd7d24d-1508-4dba-99ab-23b3166401a0"
-    );
-
-  iTwinsResponse.data!.forEach((actualOwnerMember: OwnerMember) => {
-    console.log(actualOwnerMember.id);
-  });
-}
-```
+- **`AccessControlClient`** - Main client for all access control operations
+- **`IAccessControlClient`** - Interface defining the client API surface
 
-### Create, and delete an Owner Member
+### Sub-Clients
 
-```typescript
-import type { AccessToken } from "@itwin/core-bentley";
-import {
-  AccessControlClient,
-  IAccessControlClient,
-  OwnerMember,
-  AccessControlAPIResponse,
-} from "@itwin/access-control-client";
+The `AccessControlClient` exposes the following specialized sub-clients:
 
-/** Function that creates, and deletes an owner member. */
-async function createAndRemoveOwnerMember(): Promise<void> {
-  const accessControlClient: IAccessControlClient = new AccessControlClient();
-  const accessToken: AccessToken = { get_access_token_logic_here };
-
-  // Create owner member
-  const createOwnerMemberResponse: AccessControlAPIResponse<OwnerMember> =
-    await accessControlClient.ownerMembers.addITwinOwnerMemberAsync(
-      accessToken,
-      "71fd32ed-5ee4-4e22-bc4d-b8e973e0b7b7",
-      {
-        email: "test.user@bentley.com",
-      }
-    );
-
-  // Delete owner member
-  const removeOwnerMemberResponse: AccessControlAPIResponse<undefined> =
-    await accessControlClient.ownerMembers.removeITwinOwnerMemberAsync(
-      accessToken,
-      "b1803a0c-d440-4902-b527-54bf7f72500f",
-      "6401109c-75d7-46b8-8dbd-182d02155141"
-    );
-}
-```
+#### Access Management
 
-### Get list of Groups for an iTwin
+- **`permissions`** - Query permissions across the platform and iTwins
+- **`roles`** - Manage iTwin roles (CRUD operations)
 
-```typescript
-import type { AccessToken } from "@itwin/core-bentley";
-import {
-  AccessControlClient,
-  IAccessControlClient,
-  Group,
-  AccessControlAPIResponse,
-} from "@itwin/access-control-client";
+#### Group Management
 
-/** 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);
-  });
-}
-```
+- **`groups`** - Manage iTwin groups (CRUD operations)
+- **`groupMembers`** - Manage members within groups
+- **`groupMemberInvitations`** - Handle group member invitation lifecycle
 
-### Get list of Groups for an iTwin (with custom url)
+#### User Management
 
-```typescript
-import type { AccessToken } from "@itwin/core-bentley";
-import {
-  AccessControlClient,
-  IAccessControlClient,
-  Group,
-  AccessControlAPIResponse,
-} from "@itwin/access-control-client";
+- **`userMembers`** - Manage individual user members of iTwins
+- **`ownerMembers`** - Manage iTwin owner memberships
+- **`memberInvitations`** - Handle member invitation lifecycle
 
-/** 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);
-  });
-}
-```
+#### Advanced Operations
 
-### Get specific Group for an iTwin
+- **`itwinJobs`** - Bulk operations for member management
+- **`itwinShares`** - Manage iTwin sharing and access tokens
 
-```typescript
-import type { AccessToken } from "@itwin/core-bentley";
-import {
-  AccessControlClient,
-  IAccessControlClient,
-  Group,
-  AccessControlAPIResponse,
-} from "@itwin/access-control-client";
+### Key Features
 
-/** 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);
-}
-```
+- ✅ **Complete CRUD operations** for roles, groups, and members
+- ✅ **Bulk operations** via iTwin Jobs
+- ✅ **Invitation management** for users and groups
+- ✅ **Sharing capabilities** for controlled iTwin access
+- ✅ **Type-safe API** with full TypeScript support
 
-### Create, update, and delete a Group
+### Quick Reference
 
 ```typescript
-import type { AccessToken } from "@itwin/core-bentley";
-import {
-  AccessControlClient,
-  IAccessControlClient,
-  Group,
-  AccessControlAPIResponse,
+import { AccessControlClient } from "@itwin/access-control-client";
+import type {
+  BentleyAPIResponse,
+  Role,
+  MultipleUserMembersResponse
 } 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
-    );
-}
-```
+const client = new AccessControlClient();
+const accessToken = "your-access-token-string";
+const iTwinId = "your-itwin-id";
 
-### Get list of Group Members for an iTwin
+// Get roles
+const roles = await client.roles.getITwinRoles(accessToken, iTwinId);
 
-```typescript
-import type { AccessToken } from "@itwin/core-bentley";
-import {
-  AccessControlClient,
-  IAccessControlClient,
-  Member,
-  AccessControlAPIResponse,
-} from "@itwin/access-control-client";
+// Create a role
+const newRole = await client.roles.createITwinRole(accessToken, iTwinId, {
+  displayName: "Project Manager",
+  description: "Role for project management"
+});
 
-/** 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);
-  });
-}
+// Query user members
+const members = await client.userMembers.queryITwinUserMembers(
+  accessToken,
+  iTwinId,
+  { top: 10 }
+);
+
+// Add user members
+const addedMembers = await client.userMembers.addITwinUserMembers(
+  accessToken,
+  iTwinId,
+  [{
+    email: "user@example.com",
+    roleIds: ["role-id"]
+  }],
+  "Welcome message"
+);
 ```
 
-### Get a filtered list of Group Members for an iTwin using $top/$skip
+## About this Repository
 
-```typescript
-import type { AccessToken } from "@itwin/core-bentley";
-import {
-  AccessControlClient,
-  IAccessControlClient,
-  Member,
-  AccessControlAPIResponse,
-} from "@itwin/access-control-client";
+The **@itwin/access-control-client** package provides a modern, type-safe interface to Bentley Systems' Access Control API. It manages iTwin access permissions, roles, groups, members, invitations, and sharing capabilities.
 
-/** 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);
-  });
-}
-```
+For more information about the iTwin platform and APIs, visit:
 
-### Get a specific Group Member of an iTwin
+- [iTwin Developer Portal](https://developer.bentley.com/)
+- [Access Control API Documentation](https://developer.bentley.com/apis/access-control/)
+- [iTwin.js Platform](http://www.itwinjs.org)
 
-```typescript
-import type { AccessToken } from "@itwin/core-bentley";
-import {
-  AccessControlClient,
-  IAccessControlClient,
-  Member,
-  AccessControlAPIResponse,
-} from "@itwin/access-control-client";
+## Development
 
-/** 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);
-}
-```
+### Prerequisites
 
-### Create, update, and delete a Group Member
+- Node.js 16+ and pnpm
+- TypeScript 4.5+
+- Valid iTwin Platform credentials
 
-```typescript
-import type { AccessToken } from "@itwin/core-bentley";
-import {
-  AccessControlClient,
-  IAccessControlClient,
-  Member,
-  AccessControlAPIResponse,
-} from "@itwin/access-control-client";
+### Building from Source
 
-/** 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"
-    );
-}
+```bash
+git clone https://github.com/iTwin/access-control-client.git
+cd access-control-client
+pnpm install
+pnpm build
 ```
 
-### Get a list of Permissions
+### Running Tests
 
-```typescript
-import type { AccessToken } from "@itwin/core-bentley";
-import {
-  AccessControlClient,
-  IAccessControlClient,
-  Permission,
-  AccessControlAPIResponse,
-} from "@itwin/access-control-client";
+.env file setup is required for tests. View [Getting Started](./GETTINGSTARTED.md) for more information.
 
-/** 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 };
+```bash
+# Run all tests
+pnpm test
 
-  const iTwinsResponse: AccessControlAPIResponse<Permission[]> =
-    await accessControlClient.permissions.getPermissionsAsync(accessToken);
+# Run tests with coverage
+pnpm test:coverage
 
-  iTwinsResponse.data!.forEach((actualPermission: Permission) => {
-    console.log(actualPermission.id);
-  });
-}
+# Run linting
+pnpm lint
 ```
 
-### Get a list of Permissions for an iTwin
+## Contributing
 
-```typescript
-import type { AccessToken } from "@itwin/core-bentley";
-import {
-  AccessControlClient,
-  IAccessControlClient,
-  Permission,
-  AccessControlAPIResponse,
-} from "@itwin/access-control-client";
+We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for details on:
 
-/** 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);
-  });
-}
-```
+- How to submit issues and feature requests
+- Development workflow and coding standards
+- Pull request process and review guidelines
+- Testing requirements and conventions
+- How to use changesets for versioning
 
-### Create and get iTwin job and related actions
+### Versioning
 
-```typescript
-import type { AccessToken } from "@itwin/core-bentley";
-import {
-  AccessControlClient,
-  IAccessControlClient,
-  ITwinJob,
-  ITwinJobActions,
-  AccessControlAPIResponse,
-} from "@itwin/access-control-client";
+This project uses [Changesets](https://github.com/changesets/changesets) for version management. For more information view [Contributing Guide](./CONTRIBUTING.md).
 
-/** 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 };
-
-  const itwinJobActions = {
-    assignRoles: [
-      {
-        email: "John.Johnson@example.com",
-        roleIds: ["65819672-962d-4386-8667-136125bcb7b2"],
-      },
-    ],
-    unassignRoles: [
-      {
-        email: "Maria.Miller@example.com",
-        roleIds: ["d6a62e34-5016-4bac-a9a0-a6522583698e"],
-      },
-    ],
-    removeMembers: [
-      {
-        email: "Jobby.McJobface@example.com",
-      },
-    ],
-  };
-
-  // Create iTwin job
-  const createResponse: AccessControlAPIResponse<ITwinJob> =
-    await accessControlClient.itwinJobs.createITwinJobAsync(
-      accessToken,
-      "d7d82799-3f0c-4175-acbe-cc2573e99359",
-      itwinJobActions
-    );
-
-  // Get the created iTwin job
-  const getiTwinJobResponse: AccessControlAPIResponse<ITwinJob> =
-    await accessControlClient.itwinJobs.getITwinJobAsync(
-      accessToken,
-      "d7d82799-3f0c-4175-acbe-cc2573e99359",
-      createResponse.data.id
-    );
-
-  // Get the created iTwin job with errors
-  const getiTwinJobResponseWithErrors: AccessControlAPIResponse<ITwinJob> =
-    await accessControlClient.itwinJobs.getITwinJobAsync(
-      accessToken,
-      "d7d82799-3f0c-4175-acbe-cc2573e99359",
-      createResponse.data.id,
-      "representation"
-    );
-
-  // Get the created iTwin job's actions
-  const getiTwinJobActionaResponse: AccessControlAPIResponse<ITwinJobActions> =
-    await accessControlClient.itwinJobs.getITwinJobActionsAsync(
-      accessToken,
-      "d7d82799-3f0c-4175-acbe-cc2573e99359",
-      createResponse.data.id
-    );
-}
-```
+## License
+
+Copyright © Bentley Systems, Incorporated. All rights reserved.
 
-## Contributing to this Repository
+This project is licensed under the MIT License - see the [LICENSE.md](./LICENSE.md) file for details.
 
-For information on how to contribute to this project, please read [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines, [GETTINGSTARTED.md](GETTINGSTARTED.md) for information on working with the documentation in this repository.
+---