summaryrefslogtreecommitdiffstats
path: root/docs/netdata-cloud/authentication-and-authorization
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-11-09 08:36:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-11-09 08:37:11 +0000
commit910c794ec6d0a364b4aabccf22b715cb45780e83 (patch)
tree561a9ef6b6a4668102674e1a52b3e7563c57ac61 /docs/netdata-cloud/authentication-and-authorization
parentReleasing debian version 1.47.5-1. (diff)
downloadnetdata-910c794ec6d0a364b4aabccf22b715cb45780e83.tar.xz
netdata-910c794ec6d0a364b4aabccf22b715cb45780e83.zip
Merging upstream version 2.0.0 (Closes: #923993, #1042533, #1045145).
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/netdata-cloud/authentication-and-authorization')
-rw-r--r--docs/netdata-cloud/authentication-and-authorization/api-tokens.md2
-rw-r--r--docs/netdata-cloud/authentication-and-authorization/enterprise-sso-authentication.md31
-rw-r--r--docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md6
3 files changed, 25 insertions, 14 deletions
diff --git a/docs/netdata-cloud/authentication-and-authorization/api-tokens.md b/docs/netdata-cloud/authentication-and-authorization/api-tokens.md
index 88b73ee6..a8f304ff 100644
--- a/docs/netdata-cloud/authentication-and-authorization/api-tokens.md
+++ b/docs/netdata-cloud/authentication-and-authorization/api-tokens.md
@@ -30,5 +30,5 @@ Currently, the Netdata Cloud is not exposing stable API.
* get the cloud space list
```console
-$ curl -H 'Accept: application/json' -H "Authorization: Bearer <token>" https://app.netdata.cloud/api/v2/spaces
+curl -H 'Accept: application/json' -H "Authorization: Bearer <token>" https://app.netdata.cloud/api/v2/spaces
```
diff --git a/docs/netdata-cloud/authentication-and-authorization/enterprise-sso-authentication.md b/docs/netdata-cloud/authentication-and-authorization/enterprise-sso-authentication.md
index 7657e8bc..184ff5db 100644
--- a/docs/netdata-cloud/authentication-and-authorization/enterprise-sso-authentication.md
+++ b/docs/netdata-cloud/authentication-and-authorization/enterprise-sso-authentication.md
@@ -1,36 +1,47 @@
# Enterprise SSO Authentication
Netdata provides you with means to streamline and control how your team connects and authenticates to Netdata Cloud. We provide
- diferent Single Sign-On (SSO) integrations that allow you to connect with the tool that your organization is using to manage your
+ different Single Sign-On (SSO) integrations that allow you to connect with the tool that your organization is using to manage your
user accounts.
- > ❗ This feature focus is on the Authentication flow, it doesn't support the Authorization with managing Users and Roles.
-
+ > **Note** This feature focus is on the Authentication flow, it doesn't support the Authorization with managing Users and Roles.
## How to set it up?
If you want to setup your Netdata Space to allow user Authentication through an Enterprise SSO tool you need to:
-* Confirm the integration to the tool you want is available ([Authentication integations](https://learn.netdata.cloud/docs/netdata-cloud/authentication-&-authorization/cloud-authentication-&-authorization-integrations))
+
+* Confirm the integration to the tool you want is available ([Authentication integrations](https://learn.netdata.cloud/docs/netdata-cloud/authentication-&-authorization/cloud-authentication-&-authorization-integrations))
* Have a Netdata Cloud account
* Have Access to the Space as an administrator
* Your Space needs to be on the Business plan or higher
Once you ensure the above prerequisites you need to:
+
1. Click on the Space settings cog (located above your profile icon)
2. Click on the Authentication tab
3. Select the card for the integration you are looking for, click on Configure
4. Fill the required attributes need to establish the integration with the tool
-
## How to authenticate to Netdata?
### From Netdata Sign-up page
-If you're starting your flow from Netdata sign-in page you need to:
-1. Click on the link `Sign-in with an Enterprise Signle Sign-On (SSO)`
-2. Enter your email address
-3. Go to your mailbox and check the `Sign In to Nedata` email that you have received
-4. Click on the **Sign In** button
+#### Requirements
+
+You have to update your DNS settings by adding a TXT record with the Netdata verification code as its **Value**.
+The **Value** can be found by clicking the **DNS TXT record** button in your space settings under **User Management**, in the** Authentication & Authorization** tab.
+
+Log into your domain provider’s website, and navigate to the DNS records section.
+Create a new TXT record with the following specifications:
+- Value/Answer/Description: `"netdata-verification=[VERIFICATION CODE]"`
+- Name/Host/Alias: Leave this blank or type @ to include a subdomain.
+- Time to live (TTL): "86400" (this can also be inherited from the default configuration).
+
+#### Starting the flow from Netdata sign-in page
+
+1. Click on the link `Sign-in with an Enterprise Single Sign-On (SSO)`
+2. Enter your email address
+3. Complete the SSO flow
Note: If you're not authenticated on the Enterprise SSO tool you'll be prompted to authenticate there
first before being allowed to proceed to Netdata Cloud.
diff --git a/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md b/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md
index d2a3ea4f..2226a1a0 100644
--- a/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md
+++ b/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md
@@ -108,9 +108,9 @@ In more detail, you can find on the following tables which functionalities are a
| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
|:-------------------------------|:------------------:|:------------------:|:------------------:|:------------------:|:-----------:|:------------------:|:---------------------------------------------------------------------|
-| See all functions in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
-| Run any function in Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - |
-| Run read-only function in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | |
+| See all functions in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | :: |
+| Run any function in Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | :: |
+| Run read-only function in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | :: |
| Run sensitive function in Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | There isn't any function on this category yet, so subject to change. |
### Events feed