Skip to content

Commit ed82ca5

Browse files
authored
Adding all the docs changes to match command data and setup (#112)
1 parent 19d3f73 commit ed82ca5

85 files changed

Lines changed: 372 additions & 348 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/access-control/group/create.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ Create a new group for an iTwin.
44

55
## Options
66

7+
- **`-d, --description`**
8+
A description of the group.
9+
**Type:** `string` **Required:** Yes
10+
711
- **`-i, --itwin-id`**
812
The ID of the iTwin where the group is being created.
913
**Type:** `string` **Required:** Yes
@@ -12,10 +16,6 @@ Create a new group for an iTwin.
1216
The name of the group to be created.
1317
**Type:** `string` **Required:** Yes
1418

15-
- **`-d, --description`**
16-
A description of the group.
17-
**Type:** `string` **Required:** Yes
18-
1919
## Examples
2020

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

2525
## API Reference
2626

27-
[Create iTwin Group](https://developer.bentley.com/apis/access-control-v2/operations/create-itwin-group/)
27+
[Create iTwin Group](https://developer.bentley.com/apis/access-control-v2/operations/create-itwin-group/)

docs/access-control/group/delete.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ Delete an existing group from an iTwin.
44

55
## Options
66

7-
- **`-i, --itwin-id`**
8-
The ID of the iTwin where the group exists.
9-
**Type:** `string` **Required:** Yes
10-
117
- **`-g, --group-id`**
128
The ID of the group to be deleted.
139
**Type:** `string` **Required:** Yes
1410

11+
- **`-i, --itwin-id`**
12+
The ID of the iTwin where the group exists.
13+
**Type:** `string` **Required:** Yes
14+
1515
## Examples
1616

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

2121
## API Reference
2222

23-
[Delete iTwin Group](https://developer.bentley.com/apis/access-control-v2/operations/delete-itwin-group/)
23+
[Delete iTwin Group](https://developer.bentley.com/apis/access-control-v2/operations/delete-itwin-group/)

docs/access-control/group/info.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ Retrieve details about a specific group in an iTwin.
44

55
## Options
66

7-
- **`-i, --itwin-id`**
8-
The ID of the iTwin where the group exists.
9-
**Type:** `string` **Required:** Yes
10-
117
- **`-g, --group-id`**
128
The ID of the group to retrieve information about.
139
**Type:** `string` **Required:** Yes
1410

11+
- **`-i, --itwin-id`**
12+
The ID of the iTwin where the group exists.
13+
**Type:** `string` **Required:** Yes
14+
1515
## Examples
1616

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

2121
## API Reference
2222

23-
[Get iTwin Group Info](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group/)
23+
[Get iTwin Group Info](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group/)

docs/access-control/group/list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ itp access-control group list --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51
1616

1717
## API Reference
1818

19-
[Get iTwin Groups](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-groups/)
19+
[Get iTwin Groups](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-groups/)

docs/access-control/group/update.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,29 @@ Update the details of an existing group in an iTwin.
44

55
## Options
66

7-
- **`-i, --itwin-id`**
8-
The ID of the iTwin where the group exists.
9-
**Type:** `string` **Required:** Yes
10-
117
- **`-g, --group-id`**
128
The ID of the group to be updated.
139
**Type:** `string` **Required:** Yes
1410

15-
- **`-n, --name`**
16-
The updated name of the group.
17-
**Type:** `string` **Required:** No
11+
- **`-i, --itwin-id`**
12+
The ID of the iTwin where the group exists.
13+
**Type:** `string` **Required:** Yes
1814

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

19+
- **`--ims-group`**
20+
A list of IMS Groups to be linked to the group.
21+
**Type:** `string` **Required:** No **Multiple:** Yes
22+
2323
- **`--member`**
2424
A list of members (emails) to be assigned to the group.
25-
**Type:** `array of strings` **Required:** No **Multiple:** Yes
25+
**Type:** `string` **Required:** No **Multiple:** Yes
2626

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

3131
## Examples
3232

@@ -35,9 +35,9 @@ Update the details of an existing group in an iTwin.
3535
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"
3636

3737
# Example 2: Update group members and IMS groups
38-
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"
38+
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"
3939
```
4040

4141
## API Reference
4242

43-
[Update iTwin Group](https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-group/)
43+
[Update iTwin Group](https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-group/)

docs/access-control/member/group/add.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,21 @@ Add one or more groups as members to an iTwin.
44

55
## Options
66

7+
- **`--groups`**
8+
A list of groups to add, each with a groupId and roleIds.
9+
**Type:** `string` **Required:** Yes
10+
711
- **`-i, --itwin-id`**
812
The ID of the iTwin to which the groups will be added.
913
**Type:** `string` **Required:** Yes
1014

11-
- **`--groups`**
12-
A list of groups to add, each with a groupId and roleIds.
13-
**Type:** `array` **Required:** Yes
14-
1515
## Examples
1616

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

2422
## API Reference
2523

26-
[Add iTwin Group Members](https://developer.bentley.com/apis/access-control-v2/operations/add-itwin-group-members/)
24+
[Add iTwin Group Members](https://developer.bentley.com/apis/access-control-v2/operations/add-itwin-group-members/)

docs/access-control/member/group/delete.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ Remove a group from an iTwin.
44

55
## Options
66

7-
- **`-i, --itwin-id`**
8-
The ID of the iTwin where the group is a member.
9-
**Type:** `string` **Required:** Yes
10-
117
- **`-g, --group-id`**
128
The ID of the group to remove from the iTwin.
139
**Type:** `string` **Required:** Yes
1410

11+
- **`-i, --itwin-id`**
12+
The ID of the iTwin where the group is a member.
13+
**Type:** `string` **Required:** Yes
14+
1515
## Examples
1616

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

2121
## API Reference
2222

23-
[Remove iTwin Group Member](https://developer.bentley.com/apis/access-control-v2/operations/remove-itwin-group-member/)
23+
[Remove iTwin Group Member](https://developer.bentley.com/apis/access-control-v2/operations/remove-itwin-group-member/)

docs/access-control/member/group/info.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ Retrieve details about a specific group member in an iTwin.
44

55
## Options
66

7-
- **`-i, --itwin-id`**
8-
The ID of the iTwin where the group is a member.
9-
**Type:** `string` **Required:** Yes
10-
117
- **`-g, --group-id`**
128
The ID of the group to retrieve information about.
139
**Type:** `string` **Required:** Yes
1410

11+
- **`-i, --itwin-id`**
12+
The ID of the iTwin where the group is a member.
13+
**Type:** `string` **Required:** Yes
14+
1515
## Examples
1616

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

2121
## API Reference
2222

23-
[Get iTwin Group Member](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group-member/)
23+
[Get iTwin Group Member](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group-member/)

docs/access-control/member/group/list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ itp access-control member group list --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a
1616

1717
## API Reference
1818

19-
[Get iTwin Group Members](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group-members/)
19+
[Get iTwin Group Members](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group-members/)

docs/access-control/member/group/update.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ Update the role assignments for a group in an iTwin.
44

55
## Options
66

7-
- **`-i, --itwin-id`**
8-
The ID of the iTwin where the group is a member.
9-
**Type:** `string` **Required:** Yes
10-
117
- **`-g, --group-id`**
128
The ID of the group whose roles will be updated.
139
**Type:** `string` **Required:** Yes
1410

11+
- **`-i, --itwin-id`**
12+
The ID of the iTwin to which the groups will be added.
13+
**Type:** `string` **Required:** Yes
14+
1515
- **`--role-id`**
1616
A list of role IDs to assign to the group.
17-
**Type:** `array` **Required:** Yes **Multiple:** Yes
17+
**Type:** `string` **Required:** Yes **Multiple:** Yes
1818

1919
## Examples
2020

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

2525
## API Reference
2626

27-
[Update iTwin Group Member](https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-group-member/)
27+
[Update iTwin Group Member](https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-group-member/)

0 commit comments

Comments
 (0)