summaryrefslogtreecommitdiffstats
path: root/integrations/cloud-authentication
diff options
context:
space:
mode:
authorNetdata bot <43409846+netdatabot@users.noreply.github.com>2024-04-30 19:53:27 +0300
committerGitHub <noreply@github.com>2024-04-30 19:53:27 +0300
commitc7f08e6c31b6e585b5c127fa80a37ec68e468000 (patch)
treeaa7f6b0518ea52320df20aa5a52d3ab1241da629 /integrations/cloud-authentication
parent9f0820aa66b99220d3465966a44143d450d2f7e5 (diff)
Regenerate integrations.js (#17561)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Diffstat (limited to 'integrations/cloud-authentication')
-rw-r--r--integrations/cloud-authentication/integrations/oidc.md63
1 files changed, 63 insertions, 0 deletions
diff --git a/integrations/cloud-authentication/integrations/oidc.md b/integrations/cloud-authentication/integrations/oidc.md
new file mode 100644
index 0000000000..c653513a3b
--- /dev/null
+++ b/integrations/cloud-authentication/integrations/oidc.md
@@ -0,0 +1,63 @@
+<!--startmeta
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cloud-authentication/integrations/oidc.md"
+meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-authentication/metadata.yaml"
+sidebar_label: "OIDC"
+learn_status: "Published"
+learn_rel_path: "Netdata Cloud/Authentication & Authorization/Cloud Authentication & Authorization Integrations"
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE AUTHENTICATION'S metadata.yaml FILE"
+endmeta-->
+
+# OIDC
+
+
+<img src="https://netdata.cloud/img/openid.svg" width="150"/>
+
+
+Integrate your organization's Authorization Servers with Netdata to better manage your team's access controls to Netdata Cloud.
+
+
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
+
+## Setup
+
+### Prerequisites
+- Authorization Server with OIDC protocol supported
+- A Netdata Cloud account
+- Access to the Space as an administrator
+- Space needs to be on the Business plan or higher
+
+### Setting up Authorization Server
+Your server should follow the [full specification for OIDC](https://openid.net/specs/openid-connect-core-1_0.html).
+In order to integrate your Authorization Server with Netdata the creation of a client is required. Clients are applications and services that can request authentication of a user.
+The access settings for your client are the following:
+| field | value |
+| :-- | :-- |
+| Root URL | https://app.netdata.cloud/ |
+| Home/Initiate login URL | https://app.netdata.cloud/api/v2/auth/account/auth-server?iss={your-server-issuer-url}&redirect_uri=https://app.netdata.cloud/sign-in&register_uri=https://app.netdata.cloud/sign-up/verify |
+| Redirect URL | https://app.netdata.cloud/api/v2/auth/account/auth-server/callback |
+
+### Netdata Configuration Steps
+1. Click on the Space settings cog (located above your profile icon)
+2. Click on the **Authentication** tab
+3. On the OIDC card, click on **Configure**
+4. Fill in the required credentials:
+ - **Issuer URL** the Authorization Server Issuer URL, e.g. `https://my-auth-server.com/`
+ - **Client ID** the Client ID from the created client
+ - **Client Secret** the Client Secret from the created client
+ - **Authorization URL** the Authorization Server authorization URL, e.g. `https://my-auth-server.com/openid-connect/auth`
+ - **Token URL** the Authorization Server token URL, e.g. `https://my-auth-server.com/openid-connect/token`
+ - **User URL** the Authorization Server user info URL, e.g. `https://my-auth-server.com/openid-connect/userinfo`
+
+### Supported features
+* SP-initiated SSO (Single Sign-On)
+* IdP-initiated SSO
+
+### SP-initiated SSO
+
+If you start your authentication flow from Netdata sign-in page please check [these steps](https://github.com/netdata/netdata/blob/master/docs/netdata-cloud/enterprise-sso-authentication.md#from-netdata-sign-up-page).
+
+
+### Reference
+https://openid.net/developers/how-connect-works/
+
+