summaryrefslogtreecommitdiffstats
path: root/docs/netdata-cloud/authentication-and-authorization
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-07-24 09:54:23 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-07-24 09:54:44 +0000
commit836b47cb7e99a977c5a23b059ca1d0b5065d310e (patch)
tree1604da8f482d02effa033c94a84be42bc0c848c3 /docs/netdata-cloud/authentication-and-authorization
parentReleasing debian version 1.44.3-2. (diff)
downloadnetdata-836b47cb7e99a977c5a23b059ca1d0b5065d310e.tar.xz
netdata-836b47cb7e99a977c5a23b059ca1d0b5065d310e.zip
Merging upstream version 1.46.3.
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/README.md27
-rw-r--r--docs/netdata-cloud/authentication-and-authorization/api-tokens.md34
-rw-r--r--docs/netdata-cloud/authentication-and-authorization/enterprise-sso-authentication.md36
-rw-r--r--docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md157
4 files changed, 254 insertions, 0 deletions
diff --git a/docs/netdata-cloud/authentication-and-authorization/README.md b/docs/netdata-cloud/authentication-and-authorization/README.md
new file mode 100644
index 00000000..5eb7acf2
--- /dev/null
+++ b/docs/netdata-cloud/authentication-and-authorization/README.md
@@ -0,0 +1,27 @@
+# Authentication & Authorization
+
+This section contains documentation about how Netdata allows users to Authenticate with Netdata Cloud, as well as the Authorization flows that control the access and actions of their teammates in Netdata Cloud.
+
+## Authentication
+
+### Email
+
+To sign in/sign up using email, visit [Netdata Cloud](https://app.netdata.cloud/sign-in?cloudRoute=spaces?utm_source=docs&utm_content=sign_in_button_email_section), enter your email address, and click the **Sign in by email** button.
+
+Click the **Verify** button in the email you received to start using Netdata Cloud.
+
+### Google and GitHub OAuth
+
+When you use Google/GitHub OAuth, your Netdata Cloud account is associated with the email address that Netdata Cloud receives through OAuth.
+
+To sign in/sign up using Google or GitHub OAuth, visit [Netdata Cloud](https://app.netdata.cloud/sign-in?cloudRoute=spaces?utm_source=docs&utm_content=sign_in_button_google_github_section) select the method you want to use. After the verification steps, you will be signed in to Netdata Cloud.
+
+### Enterprise SSO Authentication
+
+Netdata integrates with SSO tools, allowing you to control how your team connects and authenticates to Netdata Cloud.
+
+For more information, see [Enterprise SSO Authentication](/docs/netdata-cloud/authentication-and-authorization/enterprise-sso-authentication.md).
+
+## Authorization
+
+Once logged in, you can manage role-based access in your space to give each team member the appropriate role. For more information, see [Role-Based Access model](/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md).
diff --git a/docs/netdata-cloud/authentication-and-authorization/api-tokens.md b/docs/netdata-cloud/authentication-and-authorization/api-tokens.md
new file mode 100644
index 00000000..88b73ee6
--- /dev/null
+++ b/docs/netdata-cloud/authentication-and-authorization/api-tokens.md
@@ -0,0 +1,34 @@
+# API Tokens
+
+## Overview
+
+Every single user can get access to the Netdata resource programmatically. It is done through the API Token which
+can be also called as Bearer Token. This token is used for authentication and authorization, it can be issued
+in the Netdata UI under the user Settings:
+
+<img width="316" alt="image" src="https://github.com/netdata/netdata/assets/14999928/b0846076-afae-47ab-92df-c24967305ab9"/>
+
+The API Tokens are not going to expire and can be limited to a few scopes:
+
+* `scope:all`
+
+ this token is given the same level of action as the user has, the use-case for it is Netdata terraform provider
+
+* `scope:agent-ui`
+
+ this token is mainly used by the local Netdata agent accessing the Cloud UI
+
+* `scope:grafana-plugin`
+
+ 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, the Netdata Cloud is not exposing stable API.
+
+## Example usage
+
+* get the cloud space list
+
+```console
+$ 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
new file mode 100644
index 00000000..7657e8bc
--- /dev/null
+++ b/docs/netdata-cloud/authentication-and-authorization/enterprise-sso-authentication.md
@@ -0,0 +1,36 @@
+# 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
+ user accounts.
+
+ > ❗ 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))
+* 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
+
+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
new file mode 100644
index 00000000..fec33ca2
--- /dev/null
+++ b/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md
@@ -0,0 +1,157 @@
+# Role-Based Access model
+
+Netdata Cloud's role-based-access mechanism allows you to control what functionalities in the app users can access. Each user can be assigned only one role, which fully specifies all the capabilities they are afforded.
+
+## What roles are available?
+
+With the advent of the paid plans we revamped the roles to cover needs expressed by Netdata users, like providing more limited access to their customers, or
+being able to join any Room. We also aligned the offered roles to the target audience of each plan. The end result is the following:
+
+| **Role** | **Community** | **Homelab** | **Business** | **Enterprise On-Premise** |
+|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|:-------------------|:-------------------|:--------------------------|
+| **Admins**<p>Users with this role can control Spaces, Rooms, Nodes, Users and Billing.</p><p>They can also access any Room in the Space.</p> | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
+| **Managers**<p>Users with this role can manage Rooms and Users.</p><p>They can access any Room in the Space.</p> | - | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
+| **Troubleshooters**<p>Users with this role can use Netdata to troubleshoot, not manage entities.</p><p>They can access any Room in the Space.</p> | - | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
+| **Observers**<p>Users with this role can only view data in specific Rooms.</p>💡 Ideal for restricting your customer's access to their own dedicated rooms.<p></p> | - | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
+| **Billing**<p>Users with this role can handle billing options and invoices.</p> | - | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
+| **Member** ⚠️ Legacy role<p>Users with this role you can create Rooms and invite other Members.</p><p>They can only see the Rooms they belong to and all Nodes in the All Nodes Room.</p> | - | - | - | - |
+
+## Which functionalities are available for each role?
+
+In more detail, you can find on the following tables which functionalities are available for each role on each domain.
+
+### Space Management
+
+| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** |
+|:-----------------------|:------------------:|:------------------:|:------------------:|:------------------:|:------------------:|:------------------:|
+| See Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
+| Leave Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
+| Delete Space | :heavy_check_mark: | - | - | - | - | - |
+| Change name | :heavy_check_mark: | - | - | - | - | - |
+| Change description | :heavy_check_mark: | - | - | - | - | - |
+| Change slug | :heavy_check_mark: | - | - | - | - | - |
+| Change preferred nodes | :heavy_check_mark: | - | - | - | - | - |
+
+### Node Management
+
+| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
+|:------------------------------------------|:------------------:|:------------------:|:------------------:|:------------:|:-----------:|:------------------:|:-------------------------------------------|
+| See all Nodes in Space (_All Nodes_ Room) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | :heavy_check_mark: | Members are always on the _All Nodes_ Room |
+| Connect Node to Space | :heavy_check_mark: | - | - | - | - | - | - |
+| Delete Node from Space | :heavy_check_mark: | - | - | - | - | - | - |
+
+### User Management
+
+| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
+|:-----------------------------------|:------------------:|:------------------:|:------------------:|:------------------:|:-----------:|:------------------:|:----------------------------------------------------------------------------------------------|
+| See all Users in Space | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | |
+| Invite new User to Space | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | You can't invite a user with a role you don't have permissions to appoint to (see below) |
+| Delete Pending Invitation to Space | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | |
+| Delete User from Space | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | You can't delete a user if he has a role you don't have permissions to appoint to (see below) |
+| Appoint Administrators | :heavy_check_mark: | - | - | - | - | - | |
+| Appoint Billing user | :heavy_check_mark: | - | - | - | - | - | |
+| Appoint Managers | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
+| Appoint Troubleshooters | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
+| Appoint Observer | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
+| Appoint Member | :heavy_check_mark: | - | - | - | - | :heavy_check_mark: | Only available on Early Bird plans |
+| See all Users in a Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | |
+| Invite existing user to Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | User already invited to the Space |
+| Remove user from Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
+
+### Room Management
+
+| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
+|:-----------------------------|:------------------:|:------------------:|:------------------:|:------------------:|:-----------:|:------------------:|:-----------------------------------------------------------------------------------|
+| See all Rooms in a Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | - | |
+| Join any Room in a Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | - | By joining a Room you will be enabled to get notifications from nodes on that Room |
+| Leave Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | |
+| Create a new Room in a Space | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | |
+| Delete Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
+| Change Room name | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | If not the _All Nodes_ Room |
+| Change Room description | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | |
+| Add existing Nodes to Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | Node already connected to the Space |
+| Remove Nodes from Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | |
+
+### Notifications Management
+
+| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
+|:--------------------------------------------------------------------------|:------------------:|:------------------:|:------------------:|:------------------:|:------------------:|:------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| See all configured notifications on a Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | |
+| Add new configuration | :heavy_check_mark: | - | - | - | - | - | |
+| Enable/Disable configuration | :heavy_check_mark: | - | - | - | - | - | |
+| Edit configuration | :heavy_check_mark: | - | - | - | - | - | Some exceptions apply depending on [service level](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-notification-methods.md#available-actions-per-notification-method-based-on-service-level) |
+| Delete configuration | :heavy_check_mark: | - | - | - | - | - | |
+| Edit personal level notification settings | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | [Manage user notification settings](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-notification-methods.md#manage-user-notification-settings) |
+| See space alert notification silencing rules | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | - | |
+| Add new space alert notification silencing rule | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
+| Enable/Disable space alert notification silencing rule | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
+| Edit space alert notification silencing rule | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
+| Delete space alert notification silencing rule | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
+| See, add, edit or delete personal level alert notification silencing rule | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | |
+
+> **Note**
+>
+> Enable, Edit and Add actions over specific notification methods will only be allowed if your plan has access to those ([service classification](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md#service-classification))
+
+### Dashboards
+
+| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** |
+|:-----------------------------|:------------------:|:------------------:|:------------------:|:------------------:|:-----------:|:------------------:|
+| See all dashboards in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
+| Add new dashboard to Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
+| Edit any dashboard in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | :heavy_check_mark: |
+| Edit own dashboard in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
+| Delete any dashboard in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | :heavy_check_mark: |
+| Delete own dashboard in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
+
+### Functions
+
+| **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: | |
+| 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
+
+| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
+|:-----------------------------|:------------------:|:------------------:|:------------------:|:------------------:|:-----------:|:------------------:|:-----------------------------------------------|
+| See Alert or Topology events | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | |
+| See Auditing events | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | These are coming soon, not currently available |
+
+### Billing
+
+| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
+|:---------------------------|:------------------:|:-----------:|:------------------:|:------------:|:------------------:|:----------:|:----------------------------------------------------------------|
+| See Plan & Billing details | :heavy_check_mark: | - | - | - | :heavy_check_mark: | - | Current plan and usage figures |
+| Update plans | :heavy_check_mark: | - | - | - | - | - | This includes cancelling current plan (going to Community plan) |
+| See invoices | :heavy_check_mark: | - | - | - | :heavy_check_mark: | - | |
+| Manage payment methods | :heavy_check_mark: | - | - | - | :heavy_check_mark: | - | |
+| Update billing email | :heavy_check_mark: | - | - | - | :heavy_check_mark: | - | |
+
+### Dynamic Configuration Manager
+
+Netdata Cloud paid subscription required for all action except "List All".
+
+| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** |
+|:--------------------------------------|:------------------:|:------------------:|:------------------:|:------------------:|:------------------:|:------------------:|
+| List All (see all configurable items) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
+| Enable/Disable | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - |
+| Add | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - |
+| Update | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - |
+| Remove | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - |
+| Test | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - |
+| View | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - |
+| View File Format | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - |
+
+
+### Other permissions
+
+| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** |
+|:---------------------------|:------------------:|:------------------:|:------------------:|:------------------:|:-----------:|:------------------:|
+| See Bookmarks in Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
+| Add Bookmark to Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | :heavy_check_mark: |
+| Delete Bookmark from Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | :heavy_check_mark: |
+| See Visited Nodes | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
+| Update Visited Nodes | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |