@itwin/access-control-client 1.2.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +1 -1
- package/README.md +297 -30
- package/lib/cjs/AccessControlClient.d.ts +4 -2
- package/lib/cjs/AccessControlClient.d.ts.map +1 -1
- package/lib/cjs/AccessControlClient.js +6 -2
- package/lib/cjs/AccessControlClient.js.map +1 -1
- package/lib/cjs/accessControlTypes.d.ts +52 -13
- package/lib/cjs/accessControlTypes.d.ts.map +1 -1
- package/lib/cjs/accessControlTypes.js.map +1 -1
- package/lib/cjs/subClients/BaseClient.d.ts.map +1 -1
- package/lib/cjs/subClients/BaseClient.js +1 -0
- package/lib/cjs/subClients/BaseClient.js.map +1 -1
- package/lib/cjs/subClients/GroupMembersClient.d.ts +45 -0
- package/lib/cjs/subClients/GroupMembersClient.d.ts.map +1 -0
- package/lib/cjs/subClients/GroupMembersClient.js +70 -0
- package/lib/cjs/subClients/GroupMembersClient.js.map +1 -0
- package/lib/cjs/subClients/GroupsClient.d.ts +44 -0
- package/lib/cjs/subClients/GroupsClient.d.ts.map +1 -0
- package/lib/cjs/subClients/GroupsClient.js +60 -0
- package/lib/cjs/subClients/GroupsClient.js.map +1 -0
- package/lib/cjs/subClients/UserMembersClient.d.ts +45 -0
- package/lib/cjs/subClients/UserMembersClient.d.ts.map +1 -0
- package/lib/cjs/subClients/UserMembersClient.js +70 -0
- package/lib/cjs/subClients/UserMembersClient.js.map +1 -0
- package/lib/esm/AccessControlClient.d.ts +4 -2
- package/lib/esm/AccessControlClient.d.ts.map +1 -1
- package/lib/esm/AccessControlClient.js +6 -2
- package/lib/esm/AccessControlClient.js.map +1 -1
- package/lib/esm/accessControlTypes.d.ts +52 -13
- package/lib/esm/accessControlTypes.d.ts.map +1 -1
- package/lib/esm/accessControlTypes.js.map +1 -1
- package/lib/esm/subClients/BaseClient.d.ts.map +1 -1
- package/lib/esm/subClients/BaseClient.js +1 -0
- package/lib/esm/subClients/BaseClient.js.map +1 -1
- package/lib/esm/subClients/GroupMembersClient.d.ts +45 -0
- package/lib/esm/subClients/GroupMembersClient.d.ts.map +1 -0
- package/lib/esm/subClients/GroupMembersClient.js +66 -0
- package/lib/esm/subClients/GroupMembersClient.js.map +1 -0
- package/lib/esm/subClients/GroupsClient.d.ts +44 -0
- package/lib/esm/subClients/GroupsClient.d.ts.map +1 -0
- package/lib/esm/subClients/GroupsClient.js +56 -0
- package/lib/esm/subClients/GroupsClient.js.map +1 -0
- package/lib/esm/subClients/UserMembersClient.d.ts +45 -0
- package/lib/esm/subClients/UserMembersClient.d.ts.map +1 -0
- package/lib/esm/subClients/UserMembersClient.js +66 -0
- package/lib/esm/subClients/UserMembersClient.js.map +1 -0
- package/package.json +1 -1
- package/lib/cjs/subClients/MembersClient.d.ts +0 -45
- package/lib/cjs/subClients/MembersClient.d.ts.map +0 -1
- package/lib/cjs/subClients/MembersClient.js +0 -69
- package/lib/cjs/subClients/MembersClient.js.map +0 -1
- package/lib/esm/subClients/MembersClient.d.ts +0 -45
- package/lib/esm/subClients/MembersClient.d.ts.map +0 -1
- package/lib/esm/subClients/MembersClient.js +0 -65
- package/lib/esm/subClients/MembersClient.js.map +0 -1
|
@@ -1 +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
|
|
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 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"]}
|
|
@@ -1 +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;
|
|
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;IAgBnH;;;;QAII;IACJ,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,qBAAqB,GAAG,MAAM;CAgBlE"}
|
|
@@ -52,6 +52,7 @@ export class BaseClient {
|
|
|
52
52
|
headers: {
|
|
53
53
|
"authorization": accessTokenString,
|
|
54
54
|
"content-type": "application/json",
|
|
55
|
+
"accept": "application/vnd.bentley.itwin-platform.v2+json",
|
|
55
56
|
},
|
|
56
57
|
validateStatus(status) {
|
|
57
58
|
return status < 500; // Resolve only if the status code is less than 500
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BaseClient.js","sourceRoot":"","sources":["../../../src/subClients/BaseClient.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,MAAM,OAAO,UAAU;IAGrB,YAAmB,GAAY;QAFrB,aAAQ,GAAW,8CAA8C,CAAC;QAG1E,IAAG,GAAG,KAAK,SAAS,EAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC;SACrB;aAAM;YACL,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;YAC9C,IAAI,SAAS,EAAE;gBACb,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACvC,OAAO,CAAC,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC;gBAChD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;aAC9B;SACF;IACH,CAAC;IAED;;;;;QAKI;IACM,KAAK,CAAC,qBAAqB,CACnC,WAAwB,EACxB,MAAc,EACd,GAAW,EACX,IAAU,EACV,QAAiB;QAEjB,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QAE9E,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,cAAc,CAAC,CAAC;YAE7C,OAAO;gBACL,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,IAAI,QAAQ,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI;gBAClH,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK;aAC3B,CAAC;SACH;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO;gBACL,MAAM,EAAE,GAAG;gBACX,KAAK,EAAE;oBACL,IAAI,EAAE,qBAAqB;oBAC3B,OAAO,EACJ,6DAA6D;iBACjE;aACF,CAAC;SACH;IACH,CAAC;IAED;;;QAGI;IACM,iBAAiB,CAAC,iBAAyB,EAAE,MAAc,EAAE,GAAW,EAAE,IAAU;QAC5F,OAAO;YACL,MAAM;YACN,GAAG;YACH,IAAI;YACJ,OAAO,EAAE;gBACP,eAAe,EAAE,iBAAiB;gBAClC,cAAc,EAAE,kBAAkB;
|
|
1
|
+
{"version":3,"file":"BaseClient.js","sourceRoot":"","sources":["../../../src/subClients/BaseClient.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,MAAM,OAAO,UAAU;IAGrB,YAAmB,GAAY;QAFrB,aAAQ,GAAW,8CAA8C,CAAC;QAG1E,IAAG,GAAG,KAAK,SAAS,EAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC;SACrB;aAAM;YACL,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;YAC9C,IAAI,SAAS,EAAE;gBACb,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACvC,OAAO,CAAC,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC;gBAChD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;aAC9B;SACF;IACH,CAAC;IAED;;;;;QAKI;IACM,KAAK,CAAC,qBAAqB,CACnC,WAAwB,EACxB,MAAc,EACd,GAAW,EACX,IAAU,EACV,QAAiB;QAEjB,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QAE9E,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,cAAc,CAAC,CAAC;YAE7C,OAAO;gBACL,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,IAAI,QAAQ,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI;gBAClH,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK;aAC3B,CAAC;SACH;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO;gBACL,MAAM,EAAE,GAAG;gBACX,KAAK,EAAE;oBACL,IAAI,EAAE,qBAAqB;oBAC3B,OAAO,EACJ,6DAA6D;iBACjE;aACF,CAAC;SACH;IACH,CAAC;IAED;;;QAGI;IACM,iBAAiB,CAAC,iBAAyB,EAAE,MAAc,EAAE,GAAW,EAAE,IAAU;QAC5F,OAAO;YACL,MAAM;YACN,GAAG;YACH,IAAI;YACJ,OAAO,EAAE;gBACP,eAAe,EAAE,iBAAiB;gBAClC,cAAc,EAAE,kBAAkB;gBAClC,QAAQ,EAAE,gDAAgD;aAC3D;YACD,cAAc,CAAC,MAAM;gBACnB,OAAO,MAAM,GAAG,GAAG,CAAC,CAAC,mDAAmD;YAC1E,CAAC;SACF,CAAC;IACJ,CAAC;IAED;;;;QAII;IACM,cAAc,CAAC,QAA+B;QACtD,IAAI,WAAW,GAAG,EAAE,CAAC;QAErB,IAAI,QAAQ,CAAC,GAAG,EAAE;YAChB,WAAW,IAAI,SAAS,QAAQ,CAAC,GAAG,EAAE,CAAC;SACxC;QAED,IAAI,QAAQ,CAAC,IAAI,EAAE;YACjB,WAAW,IAAI,UAAU,QAAQ,CAAC,IAAI,EAAE,CAAC;SAC1C;QAED,8BAA8B;QAC9B,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAE/B,OAAO,WAAW,CAAC;IACrB,CAAC;CACF","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 { AccessToken } from \"@itwin/core-bentley\";\r\nimport type { Method } from \"axios\";\r\nimport type { AxiosRequestConfig } from \"axios\";\r\nimport axios from \"axios\";\r\nimport type { AccessControlAPIResponse, AccessControlQueryArg} from \"../accessControlTypes\";\r\n\r\nexport class BaseClient {\r\n protected _baseUrl: string = \"https://api.bentley.com/accesscontrol/itwins\";\r\n\r\n public constructor(url?: string) {\r\n if(url !== undefined){\r\n this._baseUrl = url;\r\n } else {\r\n const urlPrefix = process.env.IMJS_URL_PREFIX;\r\n if (urlPrefix) {\r\n const baseUrl = new URL(this._baseUrl);\r\n baseUrl.hostname = urlPrefix + baseUrl.hostname;\r\n this._baseUrl = baseUrl.href;\r\n }\r\n }\r\n }\r\n\r\n /**\r\n * Sends a basic API request\r\n * @param accessTokenString The client access token string\r\n * @param method The method type of the request (ex. GET, POST, DELETE, etc)\r\n * @param url The url of the request\r\n */\r\n protected async sendGenericAPIRequest(\r\n accessToken: AccessToken,\r\n method: Method,\r\n url: string,\r\n data?: any,\r\n property?: string\r\n ): Promise<AccessControlAPIResponse<any>> { // TODO: Change any response\r\n const requestOptions = this.getRequestOptions(accessToken, method, url, data);\r\n\r\n try {\r\n const response = await axios(requestOptions);\r\n\r\n return {\r\n status: response.status,\r\n data: response.data.error || response.data === \"\" ? undefined : property ? response.data[property] : response.data,\r\n error: response.data.error,\r\n };\r\n } catch (err) {\r\n return {\r\n status: 500,\r\n error: {\r\n code: \"InternalServerError\",\r\n message:\r\n \"An internal exception happened while calling iTwins Service\",\r\n },\r\n };\r\n }\r\n }\r\n\r\n /**\r\n * Build the request methods, headers, and other options\r\n * @param accessTokenString The client access token string\r\n */\r\n protected getRequestOptions(accessTokenString: string, method: Method, url: string, data?: any): AxiosRequestConfig {\r\n return {\r\n method,\r\n url,\r\n data,\r\n headers: {\r\n \"authorization\": accessTokenString,\r\n \"content-type\": \"application/json\",\r\n \"accept\": \"application/vnd.bentley.itwin-platform.v2+json\",\r\n },\r\n validateStatus(status) {\r\n return status < 500; // Resolve only if the status code is less than 500\r\n },\r\n };\r\n }\r\n\r\n /**\r\n * Build a query to be appended to a URL\r\n * @param queryArg Object container queryable properties\r\n * @returns query string with AccessControlQueryArg applied, which should be appended to a url\r\n */\r\n protected getQueryString(queryArg: AccessControlQueryArg): string {\r\n let queryString = \"\";\r\n\r\n if (queryArg.top) {\r\n queryString += `&$top=${queryArg.top}`;\r\n }\r\n\r\n if (queryArg.skip) {\r\n queryString += `&$skip=${queryArg.skip}`;\r\n }\r\n\r\n // trim & from start of string\r\n queryString.replace(/^&+/, \"\");\r\n\r\n return queryString;\r\n }\r\n}\r\n"]}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/** @packageDocumentation
|
|
2
|
+
* @module AccessControlClient
|
|
3
|
+
*/
|
|
4
|
+
import type { AccessToken } from "@itwin/core-bentley";
|
|
5
|
+
import type { AccessControlAPIResponse, AccessControlQueryArg, GroupMember, IGroupMembersClient } from "../accessControlTypes";
|
|
6
|
+
import { BaseClient } from "./BaseClient";
|
|
7
|
+
export declare class GroupMembersClient extends BaseClient implements IGroupMembersClient {
|
|
8
|
+
constructor(url?: string);
|
|
9
|
+
/** Retrieves a list of iTwin group members and their roles assignments.
|
|
10
|
+
* @param accessToken The client access token string
|
|
11
|
+
* @param iTwinId The id of the iTwin
|
|
12
|
+
* @returns Array of members
|
|
13
|
+
*/
|
|
14
|
+
queryITwinGroupMembersAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<GroupMember[]>>;
|
|
15
|
+
/** Retrieves a specific group member for a specified iTwin.
|
|
16
|
+
* @param accessToken The client access token string
|
|
17
|
+
* @param iTwinId The id of the iTwin
|
|
18
|
+
* @param memberId The id of the member
|
|
19
|
+
* @returns Member
|
|
20
|
+
*/
|
|
21
|
+
getITwinGroupMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<GroupMember>>;
|
|
22
|
+
/** Add new iTwin group members
|
|
23
|
+
* @param accessToken The client access token string
|
|
24
|
+
* @param iTwinId The id of the iTwin
|
|
25
|
+
* @param newMembers The list of new members to be added along with their role
|
|
26
|
+
* @returns Member[]
|
|
27
|
+
*/
|
|
28
|
+
addITwinGroupMembersAsync(accessToken: AccessToken, iTwinId: string, newMembers: GroupMember[]): Promise<AccessControlAPIResponse<GroupMember[]>>;
|
|
29
|
+
/** Remove the specified group member from the iTwin
|
|
30
|
+
* @param accessToken The client access token string
|
|
31
|
+
* @param iTwinId The id of the iTwin
|
|
32
|
+
* @param memberId The id of the member
|
|
33
|
+
* @returns No Content
|
|
34
|
+
*/
|
|
35
|
+
removeITwinGroupMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>;
|
|
36
|
+
/** Update iTwin group member roles
|
|
37
|
+
* @param accessToken The client access token string
|
|
38
|
+
* @param iTwinId The id of the iTwin
|
|
39
|
+
* @param memberId The id of the member
|
|
40
|
+
* @param roleIds The ids of the roles to be assigned
|
|
41
|
+
* @returns Member
|
|
42
|
+
*/
|
|
43
|
+
updateITwinGroupMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<AccessControlAPIResponse<GroupMember>>;
|
|
44
|
+
}
|
|
45
|
+
//# sourceMappingURL=GroupMembersClient.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"GroupMembersClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/GroupMembersClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EACV,wBAAwB,EACxB,qBAAqB,EACrB,WAAW,EACX,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,kBACX,SAAQ,UACR,YAAW,mBAAmB;gBACX,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;OAIG;IACU,2BAA2B,CACtC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,qBAAqB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,WAAW,EAAE,CAAC,CAAC;IAgBnD;;;;;OAKG;IACU,wBAAwB,CACnC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAWjD;;;;;OAKG;IACU,yBAAyB,CACpC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,WAAW,EAAE,GACxB,OAAO,CAAC,wBAAwB,CAAC,WAAW,EAAE,CAAC,CAAC;IAcnD;;;;;OAKG;IACU,2BAA2B,CACtC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAK/C;;;;;;OAMG;IACU,2BAA2B,CACtC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,wBAAwB,CAAC,WAAW,CAAC,CAAC;CAalD"}
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import { BaseClient } from "./BaseClient";
|
|
2
|
+
export class GroupMembersClient extends BaseClient {
|
|
3
|
+
constructor(url) {
|
|
4
|
+
super(url);
|
|
5
|
+
}
|
|
6
|
+
/** Retrieves a list of iTwin group members and their roles assignments.
|
|
7
|
+
* @param accessToken The client access token string
|
|
8
|
+
* @param iTwinId The id of the iTwin
|
|
9
|
+
* @returns Array of members
|
|
10
|
+
*/
|
|
11
|
+
async queryITwinGroupMembersAsync(accessToken, iTwinId, arg) {
|
|
12
|
+
let url = `${this._baseUrl}/${iTwinId}/members/groups`;
|
|
13
|
+
if (arg) {
|
|
14
|
+
url += `?${this.getQueryString(arg)}`;
|
|
15
|
+
}
|
|
16
|
+
return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "members"); // TODO: Consider how to handle paging
|
|
17
|
+
}
|
|
18
|
+
/** Retrieves a specific group member for a specified iTwin.
|
|
19
|
+
* @param accessToken The client access token string
|
|
20
|
+
* @param iTwinId The id of the iTwin
|
|
21
|
+
* @param memberId The id of the member
|
|
22
|
+
* @returns Member
|
|
23
|
+
*/
|
|
24
|
+
async getITwinGroupMemberAsync(accessToken, iTwinId, memberId) {
|
|
25
|
+
const url = `${this._baseUrl}/${iTwinId}/members/groups/${memberId}`;
|
|
26
|
+
return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "member");
|
|
27
|
+
}
|
|
28
|
+
/** Add new iTwin group members
|
|
29
|
+
* @param accessToken The client access token string
|
|
30
|
+
* @param iTwinId The id of the iTwin
|
|
31
|
+
* @param newMembers The list of new members to be added along with their role
|
|
32
|
+
* @returns Member[]
|
|
33
|
+
*/
|
|
34
|
+
async addITwinGroupMembersAsync(accessToken, iTwinId, newMembers) {
|
|
35
|
+
const url = `${this._baseUrl}/${iTwinId}/members/groups`;
|
|
36
|
+
const body = {
|
|
37
|
+
members: newMembers,
|
|
38
|
+
};
|
|
39
|
+
return this.sendGenericAPIRequest(accessToken, "POST", url, body, "members");
|
|
40
|
+
}
|
|
41
|
+
/** Remove the specified group member from the iTwin
|
|
42
|
+
* @param accessToken The client access token string
|
|
43
|
+
* @param iTwinId The id of the iTwin
|
|
44
|
+
* @param memberId The id of the member
|
|
45
|
+
* @returns No Content
|
|
46
|
+
*/
|
|
47
|
+
async removeITwinGroupMemberAsync(accessToken, iTwinId, memberId) {
|
|
48
|
+
const url = `${this._baseUrl}/${iTwinId}/members/groups/${memberId}`;
|
|
49
|
+
return this.sendGenericAPIRequest(accessToken, "DELETE", url);
|
|
50
|
+
}
|
|
51
|
+
/** Update iTwin group member roles
|
|
52
|
+
* @param accessToken The client access token string
|
|
53
|
+
* @param iTwinId The id of the iTwin
|
|
54
|
+
* @param memberId The id of the member
|
|
55
|
+
* @param roleIds The ids of the roles to be assigned
|
|
56
|
+
* @returns Member
|
|
57
|
+
*/
|
|
58
|
+
async updateITwinGroupMemberAsync(accessToken, iTwinId, memberId, roleIds) {
|
|
59
|
+
const url = `${this._baseUrl}/${iTwinId}/members/groups/${memberId}`;
|
|
60
|
+
const body = {
|
|
61
|
+
roleIds,
|
|
62
|
+
};
|
|
63
|
+
return this.sendGenericAPIRequest(accessToken, "PATCH", url, body, "member");
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
//# sourceMappingURL=GroupMembersClient.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"GroupMembersClient.js","sourceRoot":"","sources":["../../../src/subClients/GroupMembersClient.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,kBACX,SAAQ,UAAU;IAElB,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,2BAA2B,CACtC,WAAwB,EACxB,OAAe,EACf,GAA2B;QAE3B,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,iBAAiB,CAAC;QAEvD,IAAI,GAAG,EAAE;YACP,GAAG,IAAI,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;SACvC;QAED,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,KAAK,EACL,GAAG,EACH,SAAS,EACT,SAAS,CACV,CAAC,CAAC,sCAAsC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,wBAAwB,CACnC,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,mBAAmB,QAAQ,EAAE,CAAC;QACrE,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,KAAK,EACL,GAAG,EACH,SAAS,EACT,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,yBAAyB,CACpC,WAAwB,EACxB,OAAe,EACf,UAAyB;QAEzB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,iBAAiB,CAAC;QACzD,MAAM,IAAI,GAAG;YACX,OAAO,EAAE,UAAU;SACpB,CAAC;QACF,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,MAAM,EACN,GAAG,EACH,IAAI,EACJ,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,2BAA2B,CACtC,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,mBAAmB,QAAQ,EAAE,CAAC;QACrE,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,2BAA2B,CACtC,WAAwB,EACxB,OAAe,EACf,QAAgB,EAChB,OAAiB;QAEjB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,mBAAmB,QAAQ,EAAE,CAAC;QACrE,MAAM,IAAI,GAAG;YACX,OAAO;SACR,CAAC;QACF,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,OAAO,EACP,GAAG,EACH,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module AccessControlClient\n */\nimport type { AccessToken } from \"@itwin/core-bentley\";\nimport type {\n AccessControlAPIResponse,\n AccessControlQueryArg,\n GroupMember,\n IGroupMembersClient,\n} from \"../accessControlTypes\";\nimport { BaseClient } from \"./BaseClient\";\n\nexport class GroupMembersClient\n extends BaseClient\n implements IGroupMembersClient {\n public constructor(url?: string) {\n super(url);\n }\n\n /** Retrieves a list of iTwin group members and their roles assignments.\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @returns Array of members\n */\n public async queryITwinGroupMembersAsync(\n accessToken: AccessToken,\n iTwinId: string,\n arg?: AccessControlQueryArg\n ): Promise<AccessControlAPIResponse<GroupMember[]>> {\n let url = `${this._baseUrl}/${iTwinId}/members/groups`;\n\n if (arg) {\n url += `?${this.getQueryString(arg)}`;\n }\n\n return this.sendGenericAPIRequest(\n accessToken,\n \"GET\",\n url,\n undefined,\n \"members\"\n ); // TODO: Consider how to handle paging\n }\n\n /** Retrieves a specific group member for a specified iTwin.\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param memberId The id of the member\n * @returns Member\n */\n public async getITwinGroupMemberAsync(\n accessToken: AccessToken,\n iTwinId: string,\n memberId: string\n ): Promise<AccessControlAPIResponse<GroupMember>> {\n const url = `${this._baseUrl}/${iTwinId}/members/groups/${memberId}`;\n return this.sendGenericAPIRequest(\n accessToken,\n \"GET\",\n url,\n undefined,\n \"member\"\n );\n }\n\n /** Add new iTwin group members\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param newMembers The list of new members to be added along with their role\n * @returns Member[]\n */\n public async addITwinGroupMembersAsync(\n accessToken: AccessToken,\n iTwinId: string,\n newMembers: GroupMember[]\n ): Promise<AccessControlAPIResponse<GroupMember[]>> {\n const url = `${this._baseUrl}/${iTwinId}/members/groups`;\n const body = {\n members: newMembers,\n };\n return this.sendGenericAPIRequest(\n accessToken,\n \"POST\",\n url,\n body,\n \"members\"\n );\n }\n\n /** Remove the specified group member from the iTwin\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param memberId The id of the member\n * @returns No Content\n */\n public async removeITwinGroupMemberAsync(\n accessToken: AccessToken,\n iTwinId: string,\n memberId: string\n ): Promise<AccessControlAPIResponse<undefined>> {\n const url = `${this._baseUrl}/${iTwinId}/members/groups/${memberId}`;\n return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n }\n\n /** Update iTwin group member roles\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param memberId The id of the member\n * @param roleIds The ids of the roles to be assigned\n * @returns Member\n */\n public async updateITwinGroupMemberAsync(\n accessToken: AccessToken,\n iTwinId: string,\n memberId: string,\n roleIds: string[]\n ): Promise<AccessControlAPIResponse<GroupMember>> {\n const url = `${this._baseUrl}/${iTwinId}/members/groups/${memberId}`;\n const body = {\n roleIds,\n };\n return this.sendGenericAPIRequest(\n accessToken,\n \"PATCH\",\n url,\n body,\n \"member\"\n );\n }\n}\n"]}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/** @packageDocumentation
|
|
2
|
+
* @module AccessControlClient
|
|
3
|
+
*/
|
|
4
|
+
import type { AccessToken } from "@itwin/core-bentley";
|
|
5
|
+
import type { AccessControlAPIResponse, Group, IGroupsClient } from "../accessControlTypes";
|
|
6
|
+
import { BaseClient } from "./BaseClient";
|
|
7
|
+
export declare class GroupsClient extends BaseClient implements IGroupsClient {
|
|
8
|
+
constructor(url?: string);
|
|
9
|
+
/** Retrieves a list of available user roles that are defined for a specified iTwin
|
|
10
|
+
* @param accessToken The client access token string
|
|
11
|
+
* @param iTwinId The id of the iTwin
|
|
12
|
+
* @returns Group[]
|
|
13
|
+
*/
|
|
14
|
+
getITwinGroupsAsync(accessToken: AccessToken, iTwinId: string): Promise<AccessControlAPIResponse<Group[]>>;
|
|
15
|
+
/** Retrieves the specified role for the specified iTwin
|
|
16
|
+
* @param accessToken The client access token string
|
|
17
|
+
* @param iTwinId The id of the iTwin
|
|
18
|
+
* @returns Group
|
|
19
|
+
*/
|
|
20
|
+
getITwinGroupAsync(accessToken: AccessToken, iTwinId: string, groupId: string): Promise<AccessControlAPIResponse<Group>>;
|
|
21
|
+
/** Creates a new iTwin group
|
|
22
|
+
* @param accessToken The client access token string
|
|
23
|
+
* @param iTwinId The id of the iTwin
|
|
24
|
+
* @param group The group to be created
|
|
25
|
+
* @returns Group
|
|
26
|
+
*/
|
|
27
|
+
createITwinGroupAsync(accessToken: AccessToken, iTwinId: string, group: Group): Promise<AccessControlAPIResponse<Group>>;
|
|
28
|
+
/** Delete the specified iTwin group
|
|
29
|
+
* @param accessToken The client access token string
|
|
30
|
+
* @param iTwinId The id of the iTwin
|
|
31
|
+
* @param groupId The id of the group to remove
|
|
32
|
+
* @returns No Content
|
|
33
|
+
*/
|
|
34
|
+
deleteITwinGroupAsync(accessToken: AccessToken, iTwinId: string, groupId: string): Promise<AccessControlAPIResponse<undefined>>;
|
|
35
|
+
/** Update the specified iTwin group
|
|
36
|
+
* @param accessToken The client access token string
|
|
37
|
+
* @param iTwinId The id of the iTwin
|
|
38
|
+
* @param groupId The id of the role to update
|
|
39
|
+
* @param group The updated group
|
|
40
|
+
* @returns Role
|
|
41
|
+
*/
|
|
42
|
+
updateITwinGroupAsync(accessToken: AccessToken, iTwinId: string, groupId: string, group: Group): Promise<AccessControlAPIResponse<Group>>;
|
|
43
|
+
}
|
|
44
|
+
//# sourceMappingURL=GroupsClient.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"GroupsClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/GroupsClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,wBAAwB,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC5F,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,YAAa,SAAQ,UAAW,YAAW,aAAa;gBAChD,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;QAII;IACS,mBAAmB,CAC9B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,KAAK,EAAE,CAAC,CAAC;IAK7C;;;;QAII;IACS,kBAAkB,CAC7B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAK3C;;;;;QAKI;IACS,qBAAqB,CAChC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,KAAK,GACX,OAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAK3C;;;;;QAKI;IACS,qBAAqB,CAChC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAK/C;;;;;;QAMI;IACS,qBAAqB,CAChC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,KAAK,GACX,OAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;CAI5C"}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { BaseClient } from "./BaseClient";
|
|
2
|
+
export class GroupsClient extends BaseClient {
|
|
3
|
+
constructor(url) {
|
|
4
|
+
super(url);
|
|
5
|
+
}
|
|
6
|
+
/** Retrieves a list of available user roles that are defined for a specified iTwin
|
|
7
|
+
* @param accessToken The client access token string
|
|
8
|
+
* @param iTwinId The id of the iTwin
|
|
9
|
+
* @returns Group[]
|
|
10
|
+
*/
|
|
11
|
+
async getITwinGroupsAsync(accessToken, iTwinId) {
|
|
12
|
+
const url = `${this._baseUrl}/${iTwinId}/groups`;
|
|
13
|
+
return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "groups");
|
|
14
|
+
}
|
|
15
|
+
/** Retrieves the specified role for the specified iTwin
|
|
16
|
+
* @param accessToken The client access token string
|
|
17
|
+
* @param iTwinId The id of the iTwin
|
|
18
|
+
* @returns Group
|
|
19
|
+
*/
|
|
20
|
+
async getITwinGroupAsync(accessToken, iTwinId, groupId) {
|
|
21
|
+
const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;
|
|
22
|
+
return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "group");
|
|
23
|
+
}
|
|
24
|
+
/** Creates a new iTwin group
|
|
25
|
+
* @param accessToken The client access token string
|
|
26
|
+
* @param iTwinId The id of the iTwin
|
|
27
|
+
* @param group The group to be created
|
|
28
|
+
* @returns Group
|
|
29
|
+
*/
|
|
30
|
+
async createITwinGroupAsync(accessToken, iTwinId, group) {
|
|
31
|
+
const url = `${this._baseUrl}/${iTwinId}/groups`;
|
|
32
|
+
return this.sendGenericAPIRequest(accessToken, "POST", url, group, "group");
|
|
33
|
+
}
|
|
34
|
+
/** Delete the specified iTwin group
|
|
35
|
+
* @param accessToken The client access token string
|
|
36
|
+
* @param iTwinId The id of the iTwin
|
|
37
|
+
* @param groupId The id of the group to remove
|
|
38
|
+
* @returns No Content
|
|
39
|
+
*/
|
|
40
|
+
async deleteITwinGroupAsync(accessToken, iTwinId, groupId) {
|
|
41
|
+
const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;
|
|
42
|
+
return this.sendGenericAPIRequest(accessToken, "DELETE", url);
|
|
43
|
+
}
|
|
44
|
+
/** Update the specified iTwin group
|
|
45
|
+
* @param accessToken The client access token string
|
|
46
|
+
* @param iTwinId The id of the iTwin
|
|
47
|
+
* @param groupId The id of the role to update
|
|
48
|
+
* @param group The updated group
|
|
49
|
+
* @returns Role
|
|
50
|
+
*/
|
|
51
|
+
async updateITwinGroupAsync(accessToken, iTwinId, groupId, group) {
|
|
52
|
+
const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;
|
|
53
|
+
return this.sendGenericAPIRequest(accessToken, "PATCH", url, group, "group");
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
//# sourceMappingURL=GroupsClient.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"GroupsClient.js","sourceRoot":"","sources":["../../../src/subClients/GroupsClient.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,YAAa,SAAQ,UAAU;IAC1C,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,mBAAmB,CAC9B,WAAwB,EACxB,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,CAAC;QACjD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAClF,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,kBAAkB,CAC7B,WAAwB,EACxB,OAAe,EACf,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,OAAO,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,qBAAqB,CAChC,WAAwB,EACxB,OAAe,EACf,KAAY;QAEZ,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,CAAC;QACjD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,qBAAqB,CAChC,WAAwB,EACxB,OAAe,EACf,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,OAAO,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,qBAAqB,CAChC,WAAwB,EACxB,OAAe,EACf,OAAe,EACf,KAAY;QAEZ,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,OAAO,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module AccessControlClient\n */\nimport type { AccessToken } from \"@itwin/core-bentley\";\nimport type { AccessControlAPIResponse, Group, IGroupsClient } from \"../accessControlTypes\";\nimport { BaseClient } from \"./BaseClient\";\n\nexport class GroupsClient extends BaseClient implements IGroupsClient{\n public constructor(url?: string) {\n super(url);\n }\n\n /** Retrieves a list of available user roles that are defined for a specified iTwin\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @returns Group[]\n */\n public async getITwinGroupsAsync(\n accessToken: AccessToken,\n iTwinId: string,\n ): Promise<AccessControlAPIResponse<Group[]>>{\n const url = `${this._baseUrl}/${iTwinId}/groups`;\n return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"groups\");\n }\n\n /** Retrieves the specified role for the specified iTwin\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @returns Group\n */\n public async getITwinGroupAsync(\n accessToken: AccessToken,\n iTwinId: string,\n groupId: string,\n ): Promise<AccessControlAPIResponse<Group>>{\n const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;\n return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"group\");\n }\n\n /** Creates a new iTwin group\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param group The group to be created\n * @returns Group\n */\n public async createITwinGroupAsync(\n accessToken: AccessToken,\n iTwinId: string,\n group: Group\n ): Promise<AccessControlAPIResponse<Group>>{\n const url = `${this._baseUrl}/${iTwinId}/groups`;\n return this.sendGenericAPIRequest(accessToken, \"POST\", url, group, \"group\");\n }\n\n /** Delete the specified iTwin group\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param groupId The id of the group to remove\n * @returns No Content\n */\n public async deleteITwinGroupAsync(\n accessToken: AccessToken,\n iTwinId: string,\n groupId: string,\n ): Promise<AccessControlAPIResponse<undefined>>{\n const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;\n return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n }\n\n /** Update the specified iTwin group\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param groupId The id of the role to update\n * @param group The updated group\n * @returns Role\n */\n public async updateITwinGroupAsync(\n accessToken: AccessToken,\n iTwinId: string,\n groupId: string,\n group: Group\n ): Promise<AccessControlAPIResponse<Group>>{\n const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;\n return this.sendGenericAPIRequest(accessToken, \"PATCH\", url, group, \"group\");\n }\n}\n"]}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/** @packageDocumentation
|
|
2
|
+
* @module AccessControlClient
|
|
3
|
+
*/
|
|
4
|
+
import type { AccessToken } from "@itwin/core-bentley";
|
|
5
|
+
import type { AccessControlAPIResponse, AccessControlQueryArg, IUserMembersClient, UserMember } from "../accessControlTypes";
|
|
6
|
+
import { BaseClient } from "./BaseClient";
|
|
7
|
+
export declare class UserMembersClient extends BaseClient implements IUserMembersClient {
|
|
8
|
+
constructor(url?: string);
|
|
9
|
+
/** Retrieves a list of iTwin user members and their roles assignments.
|
|
10
|
+
* @param accessToken The client access token string
|
|
11
|
+
* @param iTwinId The id of the iTwin
|
|
12
|
+
* @returns Array of members
|
|
13
|
+
*/
|
|
14
|
+
queryITwinUserMembersAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<UserMember[]>>;
|
|
15
|
+
/** Retrieves a specific user member for a specified iTwin.
|
|
16
|
+
* @param accessToken The client access token string
|
|
17
|
+
* @param iTwinId The id of the iTwin
|
|
18
|
+
* @param memberId The id of the member
|
|
19
|
+
* @returns Member
|
|
20
|
+
*/
|
|
21
|
+
getITwinUserMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<UserMember>>;
|
|
22
|
+
/** Add new iTwin user members
|
|
23
|
+
* @param accessToken The client access token string
|
|
24
|
+
* @param iTwinId The id of the iTwin
|
|
25
|
+
* @param newMembers The list of new members to be added along with their role
|
|
26
|
+
* @returns Member[]
|
|
27
|
+
*/
|
|
28
|
+
addITwinUserMembersAsync(accessToken: AccessToken, iTwinId: string, newMembers: UserMember[]): Promise<AccessControlAPIResponse<UserMember[]>>;
|
|
29
|
+
/** Remove the specified user member from the iTwin
|
|
30
|
+
* @param accessToken The client access token string
|
|
31
|
+
* @param iTwinId The id of the iTwin
|
|
32
|
+
* @param memberId The id of the member
|
|
33
|
+
* @returns No Content
|
|
34
|
+
*/
|
|
35
|
+
removeITwinUserMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>;
|
|
36
|
+
/** Update iTwin user member roles
|
|
37
|
+
* @param accessToken The client access token string
|
|
38
|
+
* @param iTwinId The id of the iTwin
|
|
39
|
+
* @param memberId The id of the member
|
|
40
|
+
* @param roleIds The ids of the roles to be assigned
|
|
41
|
+
* @returns Member
|
|
42
|
+
*/
|
|
43
|
+
updateITwinUserMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<AccessControlAPIResponse<UserMember>>;
|
|
44
|
+
}
|
|
45
|
+
//# sourceMappingURL=UserMembersClient.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"UserMembersClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/UserMembersClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EACV,wBAAwB,EACxB,qBAAqB,EACrB,kBAAkB,EAClB,UAAU,EACX,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,iBACX,SAAQ,UACR,YAAW,kBAAkB;gBACV,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;OAIG;IACU,0BAA0B,CACrC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,qBAAqB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,CAAC;IAgBlD;;;;;OAKG;IACU,uBAAuB,CAClC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;IAWhD;;;;;OAKG;IACU,wBAAwB,CACnC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,UAAU,EAAE,GACvB,OAAO,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,CAAC;IAclD;;;;;OAKG;IACU,0BAA0B,CACrC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAK/C;;;;;;OAMG;IACU,0BAA0B,CACrC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;CAajD"}
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import { BaseClient } from "./BaseClient";
|
|
2
|
+
export class UserMembersClient extends BaseClient {
|
|
3
|
+
constructor(url) {
|
|
4
|
+
super(url);
|
|
5
|
+
}
|
|
6
|
+
/** Retrieves a list of iTwin user members and their roles assignments.
|
|
7
|
+
* @param accessToken The client access token string
|
|
8
|
+
* @param iTwinId The id of the iTwin
|
|
9
|
+
* @returns Array of members
|
|
10
|
+
*/
|
|
11
|
+
async queryITwinUserMembersAsync(accessToken, iTwinId, arg) {
|
|
12
|
+
let url = `${this._baseUrl}/${iTwinId}/members/users`;
|
|
13
|
+
if (arg) {
|
|
14
|
+
url += `?${this.getQueryString(arg)}`;
|
|
15
|
+
}
|
|
16
|
+
return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "members"); // TODO: Consider how to handle paging
|
|
17
|
+
}
|
|
18
|
+
/** Retrieves a specific user member for a specified iTwin.
|
|
19
|
+
* @param accessToken The client access token string
|
|
20
|
+
* @param iTwinId The id of the iTwin
|
|
21
|
+
* @param memberId The id of the member
|
|
22
|
+
* @returns Member
|
|
23
|
+
*/
|
|
24
|
+
async getITwinUserMemberAsync(accessToken, iTwinId, memberId) {
|
|
25
|
+
const url = `${this._baseUrl}/${iTwinId}/members/users/${memberId}`;
|
|
26
|
+
return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "member");
|
|
27
|
+
}
|
|
28
|
+
/** Add new iTwin user members
|
|
29
|
+
* @param accessToken The client access token string
|
|
30
|
+
* @param iTwinId The id of the iTwin
|
|
31
|
+
* @param newMembers The list of new members to be added along with their role
|
|
32
|
+
* @returns Member[]
|
|
33
|
+
*/
|
|
34
|
+
async addITwinUserMembersAsync(accessToken, iTwinId, newMembers) {
|
|
35
|
+
const url = `${this._baseUrl}/${iTwinId}/members/users`;
|
|
36
|
+
const body = {
|
|
37
|
+
members: newMembers,
|
|
38
|
+
};
|
|
39
|
+
return this.sendGenericAPIRequest(accessToken, "POST", url, body, "members");
|
|
40
|
+
}
|
|
41
|
+
/** Remove the specified user member from the iTwin
|
|
42
|
+
* @param accessToken The client access token string
|
|
43
|
+
* @param iTwinId The id of the iTwin
|
|
44
|
+
* @param memberId The id of the member
|
|
45
|
+
* @returns No Content
|
|
46
|
+
*/
|
|
47
|
+
async removeITwinUserMemberAsync(accessToken, iTwinId, memberId) {
|
|
48
|
+
const url = `${this._baseUrl}/${iTwinId}/members/users/${memberId}`;
|
|
49
|
+
return this.sendGenericAPIRequest(accessToken, "DELETE", url);
|
|
50
|
+
}
|
|
51
|
+
/** Update iTwin user member roles
|
|
52
|
+
* @param accessToken The client access token string
|
|
53
|
+
* @param iTwinId The id of the iTwin
|
|
54
|
+
* @param memberId The id of the member
|
|
55
|
+
* @param roleIds The ids of the roles to be assigned
|
|
56
|
+
* @returns Member
|
|
57
|
+
*/
|
|
58
|
+
async updateITwinUserMemberAsync(accessToken, iTwinId, memberId, roleIds) {
|
|
59
|
+
const url = `${this._baseUrl}/${iTwinId}/members/users/${memberId}`;
|
|
60
|
+
const body = {
|
|
61
|
+
roleIds,
|
|
62
|
+
};
|
|
63
|
+
return this.sendGenericAPIRequest(accessToken, "PATCH", url, body, "member");
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
//# sourceMappingURL=UserMembersClient.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"UserMembersClient.js","sourceRoot":"","sources":["../../../src/subClients/UserMembersClient.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,iBACX,SAAQ,UAAU;IAElB,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,0BAA0B,CACrC,WAAwB,EACxB,OAAe,EACf,GAA2B;QAE3B,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,gBAAgB,CAAC;QAEtD,IAAI,GAAG,EAAE;YACP,GAAG,IAAI,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;SACvC;QAED,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,KAAK,EACL,GAAG,EACH,SAAS,EACT,SAAS,CACV,CAAC,CAAC,sCAAsC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,uBAAuB,CAClC,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,kBAAkB,QAAQ,EAAE,CAAC;QACpE,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,KAAK,EACL,GAAG,EACH,SAAS,EACT,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,wBAAwB,CACnC,WAAwB,EACxB,OAAe,EACf,UAAwB;QAExB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,gBAAgB,CAAC;QACxD,MAAM,IAAI,GAAG;YACX,OAAO,EAAE,UAAU;SACpB,CAAC;QACF,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,MAAM,EACN,GAAG,EACH,IAAI,EACJ,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,0BAA0B,CACrC,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,kBAAkB,QAAQ,EAAE,CAAC;QACpE,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,0BAA0B,CACrC,WAAwB,EACxB,OAAe,EACf,QAAgB,EAChB,OAAiB;QAEjB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,kBAAkB,QAAQ,EAAE,CAAC;QACpE,MAAM,IAAI,GAAG;YACX,OAAO;SACR,CAAC;QACF,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,OAAO,EACP,GAAG,EACH,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module AccessControlClient\n */\nimport type { AccessToken } from \"@itwin/core-bentley\";\nimport type {\n AccessControlAPIResponse,\n AccessControlQueryArg,\n IUserMembersClient,\n UserMember,\n} from \"../accessControlTypes\";\nimport { BaseClient } from \"./BaseClient\";\n\nexport class UserMembersClient\n extends BaseClient\n implements IUserMembersClient {\n public constructor(url?: string) {\n super(url);\n }\n\n /** Retrieves a list of iTwin user members and their roles assignments.\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @returns Array of members\n */\n public async queryITwinUserMembersAsync(\n accessToken: AccessToken,\n iTwinId: string,\n arg?: AccessControlQueryArg\n ): Promise<AccessControlAPIResponse<UserMember[]>> {\n let url = `${this._baseUrl}/${iTwinId}/members/users`;\n\n if (arg) {\n url += `?${this.getQueryString(arg)}`;\n }\n\n return this.sendGenericAPIRequest(\n accessToken,\n \"GET\",\n url,\n undefined,\n \"members\"\n ); // TODO: Consider how to handle paging\n }\n\n /** Retrieves a specific user member for a specified iTwin.\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param memberId The id of the member\n * @returns Member\n */\n public async getITwinUserMemberAsync(\n accessToken: AccessToken,\n iTwinId: string,\n memberId: string\n ): Promise<AccessControlAPIResponse<UserMember>> {\n const url = `${this._baseUrl}/${iTwinId}/members/users/${memberId}`;\n return this.sendGenericAPIRequest(\n accessToken,\n \"GET\",\n url,\n undefined,\n \"member\"\n );\n }\n\n /** Add new iTwin user members\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param newMembers The list of new members to be added along with their role\n * @returns Member[]\n */\n public async addITwinUserMembersAsync(\n accessToken: AccessToken,\n iTwinId: string,\n newMembers: UserMember[]\n ): Promise<AccessControlAPIResponse<UserMember[]>> {\n const url = `${this._baseUrl}/${iTwinId}/members/users`;\n const body = {\n members: newMembers,\n };\n return this.sendGenericAPIRequest(\n accessToken,\n \"POST\",\n url,\n body,\n \"members\"\n );\n }\n\n /** Remove the specified user member from the iTwin\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param memberId The id of the member\n * @returns No Content\n */\n public async removeITwinUserMemberAsync(\n accessToken: AccessToken,\n iTwinId: string,\n memberId: string\n ): Promise<AccessControlAPIResponse<undefined>> {\n const url = `${this._baseUrl}/${iTwinId}/members/users/${memberId}`;\n return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n }\n\n /** Update iTwin user member roles\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param memberId The id of the member\n * @param roleIds The ids of the roles to be assigned\n * @returns Member\n */\n public async updateITwinUserMemberAsync(\n accessToken: AccessToken,\n iTwinId: string,\n memberId: string,\n roleIds: string[]\n ): Promise<AccessControlAPIResponse<UserMember>> {\n const url = `${this._baseUrl}/${iTwinId}/members/users/${memberId}`;\n const body = {\n roleIds,\n };\n return this.sendGenericAPIRequest(\n accessToken,\n \"PATCH\",\n url,\n body,\n \"member\"\n );\n }\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
/** @packageDocumentation
|
|
2
|
-
* @module AccessControlClient
|
|
3
|
-
*/
|
|
4
|
-
import type { AccessToken } from "@itwin/core-bentley";
|
|
5
|
-
import type { AccessControlAPIResponse, AccessControlQueryArg, IMembersClient, Member } from "../accessControlTypes";
|
|
6
|
-
import { BaseClient } from "./BaseClient";
|
|
7
|
-
export declare class MembersClient extends BaseClient implements IMembersClient {
|
|
8
|
-
constructor(url?: string);
|
|
9
|
-
/** Retrieves a list of iTwin members and their roles assignments.
|
|
10
|
-
* @param accessToken The client access token string
|
|
11
|
-
* @param iTwinId The id of the iTwin
|
|
12
|
-
* @returns Array of members
|
|
13
|
-
*/
|
|
14
|
-
queryITwinMembersAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<Member[]>>;
|
|
15
|
-
/** Retrieves a specific member for a specified iTwin.
|
|
16
|
-
* @param accessToken The client access token string
|
|
17
|
-
* @param iTwinId The id of the iTwin
|
|
18
|
-
* @param memberId The id of the member
|
|
19
|
-
* @returns Member
|
|
20
|
-
*/
|
|
21
|
-
getITwinMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<Member>>;
|
|
22
|
-
/** Add new iTwin members
|
|
23
|
-
* @param accessToken The client access token string
|
|
24
|
-
* @param iTwinId The id of the iTwin
|
|
25
|
-
* @param newMembers The list of new members to be added along with their role
|
|
26
|
-
* @returns Member[]
|
|
27
|
-
*/
|
|
28
|
-
addITwinMembersAsync(accessToken: AccessToken, iTwinId: string, newMembers: Member[]): Promise<AccessControlAPIResponse<Member[]>>;
|
|
29
|
-
/** Remove the specified member from the iTwin
|
|
30
|
-
* @param accessToken The client access token string
|
|
31
|
-
* @param iTwinId The id of the iTwin
|
|
32
|
-
* @param memberId The id of the member
|
|
33
|
-
* @returns No Content
|
|
34
|
-
*/
|
|
35
|
-
removeITwinMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>;
|
|
36
|
-
/** Update iTwin team member roles
|
|
37
|
-
* @param accessToken The client access token string
|
|
38
|
-
* @param iTwinId The id of the iTwin
|
|
39
|
-
* @param memberId The id of the member
|
|
40
|
-
* @param roleIds The ids of the roles to be assigned
|
|
41
|
-
* @returns Member
|
|
42
|
-
*/
|
|
43
|
-
updateITwinMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<AccessControlAPIResponse<Member>>;
|
|
44
|
-
}
|
|
45
|
-
//# sourceMappingURL=MembersClient.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"MembersClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/MembersClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACrH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,aAAc,SAAQ,UAAW,YAAW,cAAc;gBAClD,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;QAII;IACS,sBAAsB,CACjC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,qBAAqB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,MAAM,EAAE,CAAC,CAAC;IAM9C;;;;;QAKI;IACS,mBAAmB,CAC9B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAK5C;;;;;QAKI;IACS,oBAAoB,CAC/B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,wBAAwB,CAAC,MAAM,EAAE,CAAC,CAAC;IAQ9C;;;;;QAKI;IACS,sBAAsB,CACjC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAK/C;;;;;;QAMI;IACS,sBAAsB,CACjC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;CAO7C"}
|
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.MembersClient = void 0;
|
|
4
|
-
const BaseClient_1 = require("./BaseClient");
|
|
5
|
-
class MembersClient extends BaseClient_1.BaseClient {
|
|
6
|
-
constructor(url) {
|
|
7
|
-
super(url);
|
|
8
|
-
}
|
|
9
|
-
/** Retrieves a list of iTwin members and their roles assignments.
|
|
10
|
-
* @param accessToken The client access token string
|
|
11
|
-
* @param iTwinId The id of the iTwin
|
|
12
|
-
* @returns Array of members
|
|
13
|
-
*/
|
|
14
|
-
async queryITwinMembersAsync(accessToken, iTwinId, arg) {
|
|
15
|
-
let url = `${this._baseUrl}/${iTwinId}/members`;
|
|
16
|
-
if (arg)
|
|
17
|
-
url += `?${this.getQueryString(arg)}`;
|
|
18
|
-
return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "members"); // TODO: Consider how to handle paging
|
|
19
|
-
}
|
|
20
|
-
/** Retrieves a specific member for a specified iTwin.
|
|
21
|
-
* @param accessToken The client access token string
|
|
22
|
-
* @param iTwinId The id of the iTwin
|
|
23
|
-
* @param memberId The id of the member
|
|
24
|
-
* @returns Member
|
|
25
|
-
*/
|
|
26
|
-
async getITwinMemberAsync(accessToken, iTwinId, memberId) {
|
|
27
|
-
const url = `${this._baseUrl}/${iTwinId}/members/${memberId}`;
|
|
28
|
-
return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "member");
|
|
29
|
-
}
|
|
30
|
-
/** Add new iTwin members
|
|
31
|
-
* @param accessToken The client access token string
|
|
32
|
-
* @param iTwinId The id of the iTwin
|
|
33
|
-
* @param newMembers The list of new members to be added along with their role
|
|
34
|
-
* @returns Member[]
|
|
35
|
-
*/
|
|
36
|
-
async addITwinMembersAsync(accessToken, iTwinId, newMembers) {
|
|
37
|
-
const url = `${this._baseUrl}/${iTwinId}/members`;
|
|
38
|
-
const body = {
|
|
39
|
-
members: newMembers,
|
|
40
|
-
};
|
|
41
|
-
return this.sendGenericAPIRequest(accessToken, "POST", url, body, "members");
|
|
42
|
-
}
|
|
43
|
-
/** Remove the specified member from the iTwin
|
|
44
|
-
* @param accessToken The client access token string
|
|
45
|
-
* @param iTwinId The id of the iTwin
|
|
46
|
-
* @param memberId The id of the member
|
|
47
|
-
* @returns No Content
|
|
48
|
-
*/
|
|
49
|
-
async removeITwinMemberAsync(accessToken, iTwinId, memberId) {
|
|
50
|
-
const url = `${this._baseUrl}/${iTwinId}/members/${memberId}`;
|
|
51
|
-
return this.sendGenericAPIRequest(accessToken, "DELETE", url);
|
|
52
|
-
}
|
|
53
|
-
/** Update iTwin team member roles
|
|
54
|
-
* @param accessToken The client access token string
|
|
55
|
-
* @param iTwinId The id of the iTwin
|
|
56
|
-
* @param memberId The id of the member
|
|
57
|
-
* @param roleIds The ids of the roles to be assigned
|
|
58
|
-
* @returns Member
|
|
59
|
-
*/
|
|
60
|
-
async updateITwinMemberAsync(accessToken, iTwinId, memberId, roleIds) {
|
|
61
|
-
const url = `${this._baseUrl}/${iTwinId}/members/${memberId}`;
|
|
62
|
-
const body = {
|
|
63
|
-
roleIds,
|
|
64
|
-
};
|
|
65
|
-
return this.sendGenericAPIRequest(accessToken, "PATCH", url, body, "member");
|
|
66
|
-
}
|
|
67
|
-
}
|
|
68
|
-
exports.MembersClient = MembersClient;
|
|
69
|
-
//# sourceMappingURL=MembersClient.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"MembersClient.js","sourceRoot":"","sources":["../../../src/subClients/MembersClient.ts"],"names":[],"mappings":";;;AASA,6CAA0C;AAE1C,MAAa,aAAc,SAAQ,uBAAU;IAC3C,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,sBAAsB,CACjC,WAAwB,EACxB,OAAe,EACf,GAA2B;QAE3B,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,UAAU,CAAC;QAChD,IAAI,GAAG;YAAE,GAAG,IAAI,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,sCAAsC;IAC1H,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,mBAAmB,CAC9B,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,YAAY,QAAQ,EAAE,CAAC;QAC9D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAClF,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,oBAAoB,CAC/B,WAAwB,EACxB,OAAe,EACf,UAAoB;QAEpB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,UAAU,CAAC;QAClD,MAAM,IAAI,GAAG;YACX,OAAO,EAAE,UAAU;SACpB,CAAC;QACF,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,sBAAsB,CACjC,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,YAAY,QAAQ,EAAE,CAAC;QAC9D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,sBAAsB,CACjC,WAAwB,EACxB,OAAe,EACf,QAAgB,EAChB,OAAiB;QAEjB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,YAAY,QAAQ,EAAE,CAAC;QAC9D,MAAM,IAAI,GAAG;YACX,OAAO;SACR,CAAC;QACF,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC/E,CAAC;CACF;AAvFD,sCAuFC","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 { AccessToken } from \"@itwin/core-bentley\";\r\nimport type { AccessControlAPIResponse, AccessControlQueryArg, IMembersClient, Member } from \"../accessControlTypes\";\r\nimport { BaseClient } from \"./BaseClient\";\r\n\r\nexport class MembersClient extends BaseClient implements IMembersClient{\r\n public constructor(url?: string) {\r\n super(url);\r\n }\r\n\r\n /** Retrieves a list of iTwin members and their roles assignments.\r\n * @param accessToken The client access token string\r\n * @param iTwinId The id of the iTwin\r\n * @returns Array of members\r\n */\r\n public async queryITwinMembersAsync(\r\n accessToken: AccessToken,\r\n iTwinId: string,\r\n arg?: AccessControlQueryArg\r\n ): Promise<AccessControlAPIResponse<Member[]>>{\r\n let url = `${this._baseUrl}/${iTwinId}/members`;\r\n if (arg) url += `?${this.getQueryString(arg)}`;\r\n return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"members\"); // TODO: Consider how to handle paging\r\n }\r\n\r\n /** Retrieves a specific member for a specified iTwin.\r\n * @param accessToken The client access token string\r\n * @param iTwinId The id of the iTwin\r\n * @param memberId The id of the member\r\n * @returns Member\r\n */\r\n public async getITwinMemberAsync(\r\n accessToken: AccessToken,\r\n iTwinId: string,\r\n memberId: string\r\n ): Promise<AccessControlAPIResponse<Member>>{\r\n const url = `${this._baseUrl}/${iTwinId}/members/${memberId}`;\r\n return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"member\");\r\n }\r\n\r\n /** Add new iTwin members\r\n * @param accessToken The client access token string\r\n * @param iTwinId The id of the iTwin\r\n * @param newMembers The list of new members to be added along with their role\r\n * @returns Member[]\r\n */\r\n public async addITwinMembersAsync(\r\n accessToken: AccessToken,\r\n iTwinId: string,\r\n newMembers: Member[]\r\n ): Promise<AccessControlAPIResponse<Member[]>>{\r\n const url = `${this._baseUrl}/${iTwinId}/members`;\r\n const body = {\r\n members: newMembers,\r\n };\r\n return this.sendGenericAPIRequest(accessToken, \"POST\", url, body, \"members\");\r\n }\r\n\r\n /** Remove the specified member from the iTwin\r\n * @param accessToken The client access token string\r\n * @param iTwinId The id of the iTwin\r\n * @param memberId The id of the member\r\n * @returns No Content\r\n */\r\n public async removeITwinMemberAsync(\r\n accessToken: AccessToken,\r\n iTwinId: string,\r\n memberId: string\r\n ): Promise<AccessControlAPIResponse<undefined>> {\r\n const url = `${this._baseUrl}/${iTwinId}/members/${memberId}`;\r\n return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\r\n }\r\n\r\n /** Update iTwin team member roles\r\n * @param accessToken The client access token string\r\n * @param iTwinId The id of the iTwin\r\n * @param memberId The id of the member\r\n * @param roleIds The ids of the roles to be assigned\r\n * @returns Member\r\n */\r\n public async updateITwinMemberAsync(\r\n accessToken: AccessToken,\r\n iTwinId: string,\r\n memberId: string,\r\n roleIds: string[]\r\n ): Promise<AccessControlAPIResponse<Member>> {\r\n const url = `${this._baseUrl}/${iTwinId}/members/${memberId}`;\r\n const body = {\r\n roleIds,\r\n };\r\n return this.sendGenericAPIRequest(accessToken, \"PATCH\", url, body, \"member\");\r\n }\r\n}\r\n"]}
|