archive/netdata_netdata
0
0
Fork 0
mirror of https://github.com/netdata/netdata.git synced 2025-04-02 20:48:06 +00:00
Code Issues Projects Releases Wiki Activity

docs: leftover links + changes on api-tokens.md ()

Browse source 
* rebase and add the edits on meta and api tokens

* update

---------

Co-authored-by: ilyam8 <ilya@netdata.cloud>
This commit is contained in:
Fotis Voutsas 2024-12-09 13:37:21 +02:00 • committed by GitHub
parent f65cbf718f
commit 3f4428aad6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 21 additions and 16 deletions
docs/netdata-cloud/authentication-and-authorization
api-tokens.md
integrations/cloud-authentication
metadata.yaml

33
docs/netdata-cloud/authentication-and-authorization/api-tokens.md
View file

@ -1,31 +1,36 @@
# API Tokens
## Overview
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.
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:
> **Important**: API tokens never expire but should be managed carefully as they grant access to your Netdata resources.
<img width="316" alt="image" src="https://github.com/netdata/netdata/assets/14999928/b0846076-afae-47ab-92df-c24967305ab9"/>
## Token Generation
The API Tokens are not going to expire and can be limited to a few scopes:
**Location**:
* `scope:all`
Access token management through the Netdata UI:
this token is given the same level of action as the user has, the use-case for it is Netdata terraform provider
1. Click your profile picture in the bottom-left corner
2. Select "User Settings"
3. Navigate to the API Tokens section
* `scope:agent-ui`
**Available Scopes**:
this token is mainly used by the local Netdata Agent accessing the Cloud UI
Each token can be limited to specific scopes that define its access permissions:
* `scope:grafana-plugin`
| Scope | Description |
|:-----------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|
| `scope:all` | Grants the same permissions as the user who created the token. Use case: Terraform provider integration. |
| `scope:agent-ui` | Used by Agent for accessing the Cloud UI |
| `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 |
this token is used for the [Netdata Grafana plugin](https://github.com/netdata/netdata-grafana-datasource-plugin/blob/master/README.md)
to access Netdata charts
Currently, Netdata Cloud is not exposing the stable API.
> **Info**
>
> Currently, Netdata Cloud is not exposing the stable API.
## Example usage
* get the Netdata Cloud space list
**get the Netdata Cloud space list**
```console
curl -H 'Accept: application/json' -H "Authorization: Bearer <token>" https://app.netdata.cloud/api/v2/spaces

4
integrations/cloud-authentication/metadata.yaml
View file

@ -46,7 +46,7 @@
### SP-initiated SSO
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).
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).
- id: 'oidc-authentication'
meta:
@ -98,7 +98,7 @@
### SP-initiated SSO
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).
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).
### Reference