docs: leftover links + changes on api-tokens.md (#19162)
* rebase and add the edits on meta and api tokens * update --------- Co-authored-by: ilyam8 <ilya@netdata.cloud>
Fotis Voutsas committed
Dec 9, 2024 at 13:37 UTC
3f4428aad623a44c1bc425993c9cbcc3c13aae43
2 files changed
+21
-16
docs/netdata-cloud/authentication-and-authorization/api-tokens.md
+19
-14
@@ -1,31 +1,36 @@
1
# API Tokens
2
3
-## Overview
3
+API tokens (Bearer tokens) enable programmatic access to Netdata resources. These tokens authenticate and authorize API requests, allowing you to interact with Netdata services securely from external applications, scripts, or integrations.
4
5
-Every single user can get access to the Netdata resource programmatically. It is done through the API Token, also called Bearer Token. This token is used for authentication and authorization, it can be issued in the Netdata UI under the user Settings:
5
+> **Important**: API tokens never expire but should be managed carefully as they grant access to your Netdata resources.
6
7
-<img width="316" alt="image" src="https://github.com/netdata/netdata/assets/14999928/b0846076-afae-47ab-92df-c24967305ab9"/>
7
+## Token Generation
8
9
-The API Tokens are not going to expire and can be limited to a few scopes:
9
+**Location**:
10
11
-* `scope:all`
11
+Access token management through the Netdata UI:
12
13
- this token is given the same level of action as the user has, the use-case for it is Netdata terraform provider
13
+1. Click your profile picture in the bottom-left corner
14
+2. Select "User Settings"
15
+3. Navigate to the API Tokens section
16
15
-* `scope:agent-ui`
17
+**Available Scopes**:
18
17
- this token is mainly used by the local Netdata Agent accessing the Cloud UI
19
+Each token can be limited to specific scopes that define its access permissions:
20
19
-* `scope:grafana-plugin`
21
+| Scope | Description |
22
+|:-----------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|
23
+| `scope:all` | Grants the same permissions as the user who created the token. Use case: Terraform provider integration. |
24
+| `scope:agent-ui` | Used by Agent for accessing the Cloud UI |
25
+| `scope:grafana-plugin` | Used for the [Netdata Grafana plugin](https://github.com/netdata/netdata-grafana-datasource-plugin/blob/master/README.md) to access Netdata charts |
26
21
- this token is used for the [Netdata Grafana plugin](https://github.com/netdata/netdata-grafana-datasource-plugin/blob/master/README.md)
22
- to access Netdata charts
23
-
24
-Currently, Netdata Cloud is not exposing the stable API.
27
+> **Info**
28
+>
29
+> Currently, Netdata Cloud is not exposing the stable API.
30
31
## Example usage
32
28
-* get the Netdata Cloud space list
33
+**get the Netdata Cloud space list**
34
35
```console
36
curl -H 'Accept: application/json' -H "Authorization: Bearer <token>" https://app.netdata.cloud/api/v2/spaces
integrations/cloud-authentication/metadata.yaml
+2
-2
@@ -46,7 +46,7 @@
46
47
### SP-initiated SSO
48
49
- If you start your authentication flow from Netdata sign-in page please check [these steps](/docs/netdata-cloud/authentication-and-authorization/enterprise-sso-authentication.md#from-netdata-sign-up-page).
49
+ If you start your authentication flow from Netdata sign-in page please check [these steps](/docs/netdata-cloud/authentication-and-authorization/enterprise-sso-authentication.md).
50
51
- id: 'oidc-authentication'
52
meta:
@@ -98,7 +98,7 @@
98
99
### SP-initiated SSO
100
101
- If you start your authentication flow from Netdata sign-in page please check [these steps](/docs/netdata-cloud/authentication-and-authorization/enterprise-sso-authentication.md#from-netdata-sign-up-page).
101
+ If you start your authentication flow from Netdata sign-in page please check [these steps](/docs/netdata-cloud/authentication-and-authorization/enterprise-sso-authentication.md).
102
103
104
### Reference