Add OIDC docs (#17557)
* feat: add OIDC docs * Update integrations/cloud-authentication/metadata.yaml Co-authored-by: Hugo Valente <82235632+hugovalente-pm@users.noreply.github.com> * Update integrations/cloud-authentication/metadata.yaml Co-authored-by: Hugo Valente <82235632+hugovalente-pm@users.noreply.github.com> --------- Co-authored-by: Hugo Valente <82235632+hugovalente-pm@users.noreply.github.com>
Joao Cardoso committed
Apr 30, 2024 at 17:13 UTC
9f0820aa66b99220d3465966a44143d450d2f7e5
1 file changed
+55
integrations/cloud-authentication/metadata.yaml
+55
@@ -47,3 +47,58 @@
47
### SP-initiated SSO
48
49
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).
50
+
51
+- id: 'oidc-authentication'
52
+ meta:
53
+ name: 'OIDC'
54
+ link: 'https://netdata.cloud'
55
+ categories:
56
+ - auth
57
+ icon_filename: 'openid.svg'
58
+ keywords:
59
+ - sso
60
+ - oidc
61
+ overview:
62
+ authentication_description: "Integrate your organization's Authorization Servers with Netdata to better manage your team's access controls to Netdata Cloud."
63
+ authentication_limitations: ''
64
+ setup:
65
+ description: |
66
+ ### Prerequisites
67
+ - Authorization Server with OIDC protocol supported
68
+ - A Netdata Cloud account
69
+ - Access to the Space as an administrator
70
+ - Space needs to be on the Business plan or higher
71
+
72
+ ### Setting up Authorization Server
73
+ Your server should follow the [full specification for OIDC](https://openid.net/specs/openid-connect-core-1_0.html).
74
+ 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.
75
+ The access settings for your client are the following:
76
+ | field | value |
77
+ | :-- | :-- |
78
+ | Root URL | https://app.netdata.cloud/ |
79
+ | 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®ister_uri=https://app.netdata.cloud/sign-up/verify |
80
+ | Redirect URL | https://app.netdata.cloud/api/v2/auth/account/auth-server/callback |
81
+
82
+ ### Netdata Configuration Steps
83
+ 1. Click on the Space settings cog (located above your profile icon)
84
+ 2. Click on the **Authentication** tab
85
+ 3. On the OIDC card, click on **Configure**
86
+ 4. Fill in the required credentials:
87
+ - **Issuer URL** the Authorization Server Issuer URL, e.g. `https://my-auth-server.com/`
88
+ - **Client ID** the Client ID from the created client
89
+ - **Client Secret** the Client Secret from the created client
90
+ - **Authorization URL** the Authorization Server authorization URL, e.g. `https://my-auth-server.com/openid-connect/auth`
91
+ - **Token URL** the Authorization Server token URL, e.g. `https://my-auth-server.com/openid-connect/token`
92
+ - **User URL** the Authorization Server user info URL, e.g. `https://my-auth-server.com/openid-connect/userinfo`
93
+
94
+ ### Supported features
95
+ * SP-initiated SSO (Single Sign-On)
96
+ * IdP-initiated SSO
97
+
98
+ ### SP-initiated SSO
99
+
100
+ 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).
101
+
102
+
103
+ ### Reference
104
+ https://openid.net/developers/how-connect-works/