Skip to content

Commit da241e7

Browse files
authored
feat: aat token documentation, update pat token docs (#85)
## Summary by Sourcery Introduce comprehensive documentation for Application Access Tokens and Personal Access Tokens, replacing the outdated API keys documentation. Documentation: - Add documentation for Application Access Tokens, detailing creation, updating, deletion, and usage. - Add documentation for Personal Access Tokens, including creation, deletion, and usage. - Remove outdated API keys documentation. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced documentation for "Application Access Tokens" and "Personal Access Tokens" to enhance secure connections with SettleMint services. - **Documentation** - Removed outdated documentation on API keys and JSON Web Tokens (JWT). - Updated guides for creating, updating, and deleting application and personal access tokens, including usage examples. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent 9cfec9b commit da241e7

File tree

4 files changed

+95
-67
lines changed

4 files changed

+95
-67
lines changed

docs/using-platform/19_api-keys.md

Lines changed: 0 additions & 40 deletions
This file was deleted.
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Application Access Tokens
2+
3+
Application access tokens let you connect your SettleMint services with other apps securely. They represent your application, not individual users, and can be created by both admins and users. They can be used to connect to all or selected services of an application.
4+
5+
## Create an application access token
6+
7+
Go to your application's dashboard and click on "App access tokens" in the left navigation.
8+
9+
Click on the "Add an application access token" button. This opens a form where you can create your application access token.
10+
11+
1. Choose a **name** for your application access token.
12+
2. Select an **expiration date**. You cannot update this later.
13+
3. Select a scope type. There are two types of scope: **All** or **Specific**.
14+
1. If you selected **All**, you grant access to all services of the application. If you add more services to the application later, this access token will grant access to these new services as well.
15+
2. If you selected **Specific**, you can choose which specific services this access token will grant access to.
16+
3. You can also update the scopes of your application access token later.
17+
4. Click **Confirm** to create your application access token.
18+
19+
:::warning Warning
20+
21+
Copy and save your token securely - you won't see it again. Treat it like a password and keep it secret.
22+
23+
:::
24+
25+
## Update an application access token
26+
27+
Navigate to the **application** whose token you want to update.
28+
29+
1. Click **App Access Tokens** in the left navigation, you will see a list of all application access tokens for this application.
30+
2. Click on **View scopes** of the token you wish to update. This will first open a list where you can view the current scopes of the token.
31+
3. Click on **Update** in the bottom right corner to open a form where you can update your application access token.
32+
4. Choose the new scopes for your application access token.
33+
5. Click **Confirm** to update your application access token.
34+
35+
## Delete an application access token
36+
37+
If you are worried that an application access token has been compromised, or you no longer use the integration for which you had generated a particular application access token, you can delete that application access token.
38+
39+
1. Navigate to the application dashboard whose application access tokens you wish to delete.
40+
2. Click **App Access Tokens** in the left navigation.
41+
3. Click **Delete** next to the application access token you want to delete.
42+
4. Type **DELETE** to confirm. The application access token will no longer be usable.
43+
44+
## Use an application access token
45+
46+
You can use these application access tokens in three ways depending on what works for your use case.
47+
48+
- As a header, you can use the header `x-auth-token: TOKEN`.
49+
- As a query parameter using `https://myservice.settlemint.com/?token=TOKEN` appended to any URL.
50+
- As the last part of the URL `https://myservice.settlemint.com/TOKEN`.
51+
- For IPFS nodes build your uri so it becomes `https://myservice.settlemint.com/TOKEN/api/v0/...`
52+
- For Avalanche and Fuji build your uri so they look like `https://myservice.settlemint.com/ext/bc/C/rpc/TOKEN`
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Personal access tokens
2+
3+
Personal access tokens (or [Application access tokens](19_application-access-tokens.md)) let you connect your SettleMint services with other apps securely. They represent an individual user, and have the same rights as the user's role in the organization (admin or user). They can be used to connect to all services that the user has access to.
4+
5+
## Create a personal access token
6+
7+
In the upper right corner of any page, click your **profile picture or avatar**, and then click **Personal access tokens**.
8+
9+
Click on the **Add a personal access token** button, this opens a form where you can create your personal access token.
10+
11+
1. Choose a **name** for your personal access token.
12+
2. Select an **expiration date**. You cannot update this later.
13+
3. Click **Confirm** to create your personal access token.
14+
15+
:::warning Warning
16+
17+
Copy and save your token securely - you won't see it again. Treat it like a password and keep it secret.
18+
19+
:::
20+
21+
## Delete a personal access token
22+
23+
If you are worried that your personal access token has been compromised, or you no longer use the integration for which you had generated a particular personal access token, you can delete that personal access token.
24+
25+
1. Navigate to the list of your personal access tokens, and find the personal access token you want to delete.
26+
2. Click **Delete** next to the personal access token.
27+
3. Type **DELETE** to confirm. The personal access token will no longer be usable.
28+
29+
## Use a personal access token
30+
31+
You can use these personal access tokens in three ways depending on what works for your use case.
32+
33+
- As a header, you can use the header `x-auth-token: TOKEN`.
34+
- As a query parameter using `https://myservice.settlemint.com/?token=TOKEN` appended to any URL.
35+
- As the last part of the URL `https://myservice.settlemint.com/TOKEN`.
36+
- For IPFS nodes build your uri so it becomes `https://myservice.settlemint.com/TOKEN/api/v0/...`
37+
- For Avalanche and Fuji build your uri so they look like `https://myservice.settlemint.com/ext/bc/C/rpc/TOKEN`
38+
39+
## Using application access tokens vs personal access tokens
40+
41+
For most use cases, you should use application access tokens. Since they are directly linked to the application, the token continues to work even if the user leaves the organization. They also provide more granular access control.
42+
43+
Personal access tokens are a simpler way to authenticate, but they are linked to the user's account. If the user leaves the organization, the token will no longer work for the services of that organization.

docs/using-platform/21_JWT.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

0 commit comments

Comments
 (0)