Skip to content

Commit aedf301

Browse files
committed
Merge branch 'api-docs'
2 parents ae911ba + 3fcb5e2 commit aedf301

17 files changed

+378
-19
lines changed

docs/docs/introduction/create-api-user-dialog-1.drawio.svg

Lines changed: 68 additions & 0 deletions
Loading
223 KB
Loading

docs/docs/introduction/create-api-user-dialog-2.drawio.svg

Lines changed: 44 additions & 0 deletions
Loading
366 KB
Loading

docs/docs/introduction/create-api-user-dialog-3.drawio.svg

Lines changed: 44 additions & 0 deletions
Loading
440 KB
Loading

docs/docs/introduction/create-api-user-dialog-4.drawio.svg

Lines changed: 44 additions & 0 deletions
Loading
380 KB
Loading

docs/docs/introduction/index.mdx

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,28 +27,40 @@ Get started with the Mesh API using the API User Service.
2727

2828
### 1. Create an API User and Credentials
2929

30-
1. Log into Mesh as an administrator and go to the API Users tab on the **[administration page](https://app.mesh.trade/administration/manage/api-users)**.
31-
Then click the **Create API User** button on the table header.
30+
- Log in to Mesh and select [API Users](https://app.mesh.trade/api-users) from the user drop down menu on the main task bar to get to the [API User Management Screen](https://app.mesh.trade/api-users).
3231

33-
![Administration API Keys Create](./administration-api-keys-create.png)
32+
![Navigate to API Users](./navigate-to-api-users.png)
3433

35-
2. Enter a display name for the API User and select one or more roles (for the coming example to work select *at least* the **IAM Viewer** Role).
36-
These roles will be assigned to the API User **in the group** that will own it - the top level group of the client that you are logged in as.
37-
Select **Create API user** to complete the creation.
34+
- Select the 'Create API User' button in the top right of the table to open the API User Creation dialog.
35+
36+
![Select to create API User](./select-to-create-api-user.png)
37+
38+
- Enter a display name for the API User and select one or more groups in which roles are to be granted to the new API User.
39+
40+
<div style={{display: 'flex', gap: '8px', flexDirection: 'row', marginTop: '15px', justifyContent: 'center'}}>
41+
42+
![Create API User Dialog 1](./create-api-user-dialog-1.png)
43+
44+
![Create API User Dialog 2](./create-api-user-dialog-2.png)
45+
46+
</div>
47+
48+
- Then select roles to Assign to the API User in the selected group(s) (for the coming example to work select *at least* the **IAM Viewer** Role).
49+
- Select **Create API user** to complete the creation.
3850

3951
<div style={{display: 'flex', gap: '8px', flexDirection: 'row', marginTop: '15px', justifyContent: 'center'}}>
4052

41-
![Create API User Dialog](./create-api-user-dialog.png)
53+
![Create API User Dialog 3](./create-api-user-dialog-3.png)
4254

43-
![Create API User Dialog Add Roles](./create-api-user-dialog-add-roles.png)
55+
![Create API User Dialog 4](./create-api-user-dialog-4.png)
4456

4557
</div>
4658

4759
:::info
48-
See **[Access Control](/docs/access-control/)** for more information on group structures in Mesh.
60+
See **[Access Control](/docs/access-control/)** for more information on group, roles access control in Mesh.
4961
:::
5062

51-
3. On successful creation a dialog opens with the new API User's credentials.
63+
- On successful creation a dialog opens with the new API User's credentials.
5264
Download or copy them.
5365
They are required to authenticate SDKs to use the Mesh API.
5466

@@ -58,7 +70,7 @@ They are required to authenticate SDKs to use the Mesh API.
5870
Keep your API credentials file **secure**! Never commit this credentials file to version control!
5971
:::
6072

61-
3. The new API User is inactive on creation. Select its row in the table and click on the Activate button in the
73+
- The new API User is inactive on creation. Select its row in the table and click on the Activate button in the
6274
table header to activate it so that it is ready for use.
6375

6476
![Create API User Dialog](./activate-api-user.png)

docs/docs/introduction/navigate-to-api-users.drawio.svg

Lines changed: 74 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)