Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/access-control/group/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ Create a new group for an iTwin.

## Options

- **`-d, --description`**
A description of the group.
**Type:** `string` **Required:** Yes

- **`-i, --itwin-id`**
The ID of the iTwin where the group is being created.
**Type:** `string` **Required:** Yes
Expand All @@ -12,10 +16,6 @@ Create a new group for an iTwin.
The name of the group to be created.
**Type:** `string` **Required:** Yes

- **`-d, --description`**
A description of the group.
**Type:** `string` **Required:** Yes

## Examples

```bash
Expand All @@ -24,4 +24,4 @@ itp access-control group create --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51

## API Reference

[Create iTwin Group](https://developer.bentley.com/apis/access-control-v2/operations/create-itwin-group/)
[Create iTwin Group](https://developer.bentley.com/apis/access-control-v2/operations/create-itwin-group/)
10 changes: 5 additions & 5 deletions docs/access-control/group/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ Delete an existing group from an iTwin.

## Options

- **`-i, --itwin-id`**
The ID of the iTwin where the group exists.
**Type:** `string` **Required:** Yes

- **`-g, --group-id`**
The ID of the group to be deleted.
**Type:** `string` **Required:** Yes

- **`-i, --itwin-id`**
The ID of the iTwin where the group exists.
**Type:** `string` **Required:** Yes

## Examples

```bash
Expand All @@ -20,4 +20,4 @@ itp access-control group delete --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51

## API Reference

[Delete iTwin Group](https://developer.bentley.com/apis/access-control-v2/operations/delete-itwin-group/)
[Delete iTwin Group](https://developer.bentley.com/apis/access-control-v2/operations/delete-itwin-group/)
10 changes: 5 additions & 5 deletions docs/access-control/group/info.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ Retrieve details about a specific group in an iTwin.

## Options

- **`-i, --itwin-id`**
The ID of the iTwin where the group exists.
**Type:** `string` **Required:** Yes

- **`-g, --group-id`**
The ID of the group to retrieve information about.
**Type:** `string` **Required:** Yes

- **`-i, --itwin-id`**
The ID of the iTwin where the group exists.
**Type:** `string` **Required:** Yes

## Examples

```bash
Expand All @@ -20,4 +20,4 @@ itp access-control group info --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --

## API Reference

[Get iTwin Group Info](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group/)
[Get iTwin Group Info](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group/)
2 changes: 1 addition & 1 deletion docs/access-control/group/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ itp access-control group list --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51

## API Reference

[Get iTwin Groups](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-groups/)
[Get iTwin Groups](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-groups/)
26 changes: 13 additions & 13 deletions docs/access-control/group/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,29 @@ Update the details of an existing group in an iTwin.

## Options

- **`-i, --itwin-id`**
The ID of the iTwin where the group exists.
**Type:** `string` **Required:** Yes

- **`-g, --group-id`**
The ID of the group to be updated.
**Type:** `string` **Required:** Yes

- **`-n, --name`**
The updated name of the group.
**Type:** `string` **Required:** No
- **`-i, --itwin-id`**
The ID of the iTwin where the group exists.
**Type:** `string` **Required:** Yes

- **`-d, --description`**
The updated description of the group.
**Type:** `string` **Required:** No

- **`--ims-group`**
A list of IMS Groups to be linked to the group.
**Type:** `string` **Required:** No **Multiple:** Yes

- **`--member`**
A list of members (emails) to be assigned to the group.
**Type:** `array of strings` **Required:** No **Multiple:** Yes
**Type:** `string` **Required:** No **Multiple:** Yes

- **`--ims-group`**
A list of IMS Groups to be linked to the group.
**Type:** `array of strings` **Required:** No **Multiple:** Yes
- **`-n, --name`**
The updated name of the group.
**Type:** `string` **Required:** No

## Examples

Expand All @@ -35,9 +35,9 @@ Update the details of an existing group in an iTwin.
itp access-control group update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --group-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 --name "Updated Engineering Team" --description "Updated description"

# Example 2: Update group members and IMS groups
itp access-control group update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --group-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 --member john.doe@example.com --member jane.doe@example.com --ims-groups "Sample IMS Group" --ims-group "Sample IMS Group"
itp access-control group update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --group-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 --member john.doe@example.com --member jane.doe@example.com --ims-group "Sample IMS Group" --ims-group "Sample IMS Group"
```

## API Reference

[Update iTwin Group](https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-group/)
[Update iTwin Group](https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-group/)
16 changes: 7 additions & 9 deletions docs/access-control/member/group/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,21 @@ Add one or more groups as members to an iTwin.

## Options

- **`--groups`**
A list of groups to add, each with a groupId and roleIds.
**Type:** `string` **Required:** Yes

- **`-i, --itwin-id`**
The ID of the iTwin to which the groups will be added.
**Type:** `string` **Required:** Yes

- **`--groups`**
A list of groups to add, each with a groupId and roleIds.
**Type:** `array` **Required:** Yes

## Examples

```bash
itp access-control member group add --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --groups '[
{"groupId": "group1-id", "roleIds": ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1", "83ee0d80-dea3-495a-b6c0-7bb102ebbcc3"]},
{"groupId": "group2-id", "roleIds": ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1"]}
]'
# Example 1: Add one or more groups as members to an iTwin.
itp access-control member group add --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --groups '[{"groupId": "group1-id", "roleIds": ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1", "83ee0d80-dea3-495a-b6c0-7bb102ebbcc3"]}, {"groupId": "group2-id", "roleIds": ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1"]}]',
```

## API Reference

[Add iTwin Group Members](https://developer.bentley.com/apis/access-control-v2/operations/add-itwin-group-members/)
[Add iTwin Group Members](https://developer.bentley.com/apis/access-control-v2/operations/add-itwin-group-members/)
10 changes: 5 additions & 5 deletions docs/access-control/member/group/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ Remove a group from an iTwin.

## Options

- **`-i, --itwin-id`**
The ID of the iTwin where the group is a member.
**Type:** `string` **Required:** Yes

- **`-g, --group-id`**
The ID of the group to remove from the iTwin.
**Type:** `string` **Required:** Yes

- **`-i, --itwin-id`**
The ID of the iTwin where the group is a member.
**Type:** `string` **Required:** Yes

## Examples

```bash
Expand All @@ -20,4 +20,4 @@ itp access-control member group delete --itwin-id ad0ba809-9241-48ad-9eb0-c8038c

## API Reference

[Remove iTwin Group Member](https://developer.bentley.com/apis/access-control-v2/operations/remove-itwin-group-member/)
[Remove iTwin Group Member](https://developer.bentley.com/apis/access-control-v2/operations/remove-itwin-group-member/)
10 changes: 5 additions & 5 deletions docs/access-control/member/group/info.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ Retrieve details about a specific group member in an iTwin.

## Options

- **`-i, --itwin-id`**
The ID of the iTwin where the group is a member.
**Type:** `string` **Required:** Yes

- **`-g, --group-id`**
The ID of the group to retrieve information about.
**Type:** `string` **Required:** Yes

- **`-i, --itwin-id`**
The ID of the iTwin where the group is a member.
**Type:** `string` **Required:** Yes

## Examples

```bash
Expand All @@ -20,4 +20,4 @@ itp access-control member group info --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a

## API Reference

[Get iTwin Group Member](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group-member/)
[Get iTwin Group Member](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group-member/)
2 changes: 1 addition & 1 deletion docs/access-control/member/group/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ itp access-control member group list --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a

## API Reference

[Get iTwin Group Members](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group-members/)
[Get iTwin Group Members](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group-members/)
12 changes: 6 additions & 6 deletions docs/access-control/member/group/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ Update the role assignments for a group in an iTwin.

## Options

- **`-i, --itwin-id`**
The ID of the iTwin where the group is a member.
**Type:** `string` **Required:** Yes

- **`-g, --group-id`**
The ID of the group whose roles will be updated.
**Type:** `string` **Required:** Yes

- **`-i, --itwin-id`**
The ID of the iTwin to which the groups will be added.
**Type:** `string` **Required:** Yes

- **`--role-id`**
A list of role IDs to assign to the group.
**Type:** `array` **Required:** Yes **Multiple:** Yes
**Type:** `string` **Required:** Yes **Multiple:** Yes

## Examples

Expand All @@ -24,4 +24,4 @@ itp access-control member group update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c

## API Reference

[Update iTwin Group Member](https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-group-member/)
[Update iTwin Group Member](https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-group-member/)
2 changes: 1 addition & 1 deletion docs/access-control/member/invitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ itp access-control member invitations --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1

## API Reference

[Get iTwin Member Invitations](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-member-invitations/)
[Get iTwin Member Invitations](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-member-invitations/)
10 changes: 5 additions & 5 deletions docs/access-control/member/owner/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ Add a new owner to an iTwin by email.

## Options

- **`-i, --itwin-id`**
The ID of the iTwin to which the owner will be added.
**Type:** `string` **Required:** Yes

- **`--email`**
The email address of the new owner.
**Type:** `string` **Required:** Yes

- **`-i, --itwin-id`**
The ID of the iTwin to which the owner will be added.
**Type:** `string` **Required:** Yes

## Examples

```bash
Expand All @@ -20,4 +20,4 @@ itp access-control member owner add --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1

## API Reference

[Add iTwin Owner](https://developer.bentley.com/apis/access-control-v2/operations/add-itwin-owner-member/)
[Add iTwin Owner](https://developer.bentley.com/apis/access-control-v2/operations/add-itwin-owner-member/)
2 changes: 1 addition & 1 deletion docs/access-control/member/owner/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ itp access-control member owner delete --itwin-id ad0ba809-9241-48ad-9eb0-c8038c

## API Reference

[Remove iTwin Owner](https://developer.bentley.com/apis/access-control-v2/operations/remove-itwin-owner-member/)
[Remove iTwin Owner](https://developer.bentley.com/apis/access-control-v2/operations/remove-itwin-owner-member/)
2 changes: 1 addition & 1 deletion docs/access-control/member/owner/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ itp access-control member owner list --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a

## API Reference

[Get iTwin Owner Members](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-owner-members/)
[Get iTwin Owner Members](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-owner-members/)
11 changes: 4 additions & 7 deletions docs/access-control/member/user/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,15 @@ Add one or more user members to an iTwin.

- **`--members`**
A list of members to add, each with an email and a list of role IDs.
**Type:** `array` **Required:** Yes
**Type:** `string` **Required:** Yes

## Examples

```bash
# Example: Add multiple users to an iTwin with role IDs
itp access-control member user add --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --members '[
{"email": "john.johnson@example.com", "roleIds": ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1", "83ee0d80-dea3-495a-b6c0-7bb102ebbcc3"]},
{"email": "maria.miller@example.com", "roleIds": ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1"]}
]'
# Example 1: Add multiple users to an iTwin with role IDs
itp access-control member user add --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --members '[{"email": "user1@example.com", "roleIds": ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1", "83ee0d80-dea3-495a-b6c0-7bb102ebbcc3"]}, {"email": "user2@example.com", "roleIds": ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1"]}]'
```

## API Reference

[Add iTwin User Members](https://developer.bentley.com/apis/access-control-v2/operations/add-itwin-user-members/)
[Add iTwin User Members](https://developer.bentley.com/apis/access-control-v2/operations/add-itwin-user-members/)
2 changes: 1 addition & 1 deletion docs/access-control/member/user/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ itp access-control member user delete --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1

## API Reference

[Remove iTwin User Member](https://developer.bentley.com/apis/access-control-v2/operations/remove-itwin-user-member/)
[Remove iTwin User Member](https://developer.bentley.com/apis/access-control-v2/operations/remove-itwin-user-member/)
2 changes: 1 addition & 1 deletion docs/access-control/member/user/info.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ itp access-control member user info --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1

## API Reference

[Get iTwin User Member](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-user-member/)
[Get iTwin User Member](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-user-member/)
2 changes: 1 addition & 1 deletion docs/access-control/member/user/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ itp access-control member user list --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1

## API Reference

[Get iTwin User Members](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-user-members/)
[Get iTwin User Members](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-user-members/)
4 changes: 2 additions & 2 deletions docs/access-control/member/user/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Update the role assignments for a user in an iTwin.

- **`--role-id`**
A list of role IDs to assign to the user.
**Type:** `array` **Required:** Yes **Multiple:** Yes
**Type:** `string` **Required:** Yes **Multiple:** Yes

## Examples

Expand All @@ -24,4 +24,4 @@ itp access-control member user update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1

## API Reference

[Update iTwin User Member](https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-user-member/)
[Update iTwin User Member](https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-user-member/)
4 changes: 2 additions & 2 deletions docs/access-control/permissions/all.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Retrieve a list of all iTwin Platform permissions.

## Options

(No options required for this command)
(This command does not have any options)

## Examples

Expand All @@ -14,4 +14,4 @@ itp access-control permissions all

## API Reference

[Get All Permissions](https://developer.bentley.com/apis/access-control-v2/operations/get-all-permissions/)
[Get All Permissions](https://developer.bentley.com/apis/access-control-v2/operations/get-all-permissions/)
2 changes: 1 addition & 1 deletion docs/access-control/permissions/me.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ itp access-control permissions me --itwin-id e9a0d55a-65aa-42bd-9aa3-fd1c68d5e7b

## API Reference

[Get My iTwin Permissions](https://developer.bentley.com/apis/access-control-v2/operations/get-iTwin-permissions/)
[Get My iTwin Permissions](https://developer.bentley.com/apis/access-control-v2/operations/get-iTwin-permissions/)
Loading