Skip to content

Commit c8a8a14

Browse files
committed
refactor: add additional step on sql account api secret key setup
1 parent 93f653a commit c8a8a14

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

docs/integration/sql-account-api/setup-configuration.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,23 @@ tags: ["SQL Account", "SQL Account API", "Secret Key"]
1111

1212
> API secret key allow the user/application to access SQL Account API Service in a secured channel.
1313
14+
:::warning[Important Note]
15+
Once an `API Secret Key` is generated for a user, that user will no longer be able to login on SQL Account directly. The user will be used solely for `SQL Account API Service`. We recommend to create a new user for the API usage.
16+
:::
17+
1418
1. In SQL Account, go to `Tools` > `Maintain User...` > `Detail`
1519

16-
2. In the window, click on `More` > `API Secret Key`
20+
2. Create a new user by clicking `New`, name it "API user"
1721

18-
![1](../../../static/img/integration/sql-account-api/setup-configuration/1.png)
22+
3. Next, highlight on the new user, click on `More` > `API Secret Key`
1923

20-
3. Click on `Generate API Secret Key`
24+
![1](../../../static/img/integration/sql-account-api/setup-configuration/1.png)
2125

22-
:::warning[Important Note]
23-
Once an `API Secret Key` is generated for a user, that user will no longer be able to login on SQL Account directly. The user will be used solely for `SQL Account API Service`. We recommend to create a new user for the API usage.
24-
:::
26+
4. Click on `Generate API Secret Key`
2527

2628
![2](../../../static/img/integration/sql-account-api/setup-configuration/2.png)
2729

28-
4. New `Access key` and `Secret Key` will be generated and shown in the screen. Make sure to copy and save them immediately in a secure location.
30+
5. New `Access key` and `Secret Key` will be generated and shown in the screen. Make sure to copy and save them immediately in a secure location.
2931

3032
:::info[Tip]
3133
For security purpose, **API Secret Key** can only be retrieved at the time of generated. If you lose it, you can `revoke` and `generate` a new API Secret Key.
11.3 KB
Loading

0 commit comments

Comments
 (0)