Regenerate integrations.js (#17561)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Apr 30, 2024 at 19:53 UTC
c7f08e6c31b6e585b5c127fa80a37ec68e468000
3 files changed
+103
integrations/cloud-authentication/integrations/oidc.md
new
+63
@@ -0,0 +1,63 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cloud-authentication/integrations/oidc.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-authentication/metadata.yaml"
4
+sidebar_label: "OIDC"
5
+learn_status: "Published"
6
+learn_rel_path: "Netdata Cloud/Authentication & Authorization/Cloud Authentication & Authorization Integrations"
7
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE AUTHENTICATION'S metadata.yaml FILE"
8
+endmeta-->
9
+
10
+# OIDC
11
+
12
+
13
+<img src="https://netdata.cloud/img/openid.svg" width="150"/>
14
+
15
+
16
+Integrate your organization's Authorization Servers with Netdata to better manage your team's access controls to Netdata Cloud.
17
+
18
+
19
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
20
+
21
+## Setup
22
+
23
+### Prerequisites
24
+- Authorization Server with OIDC protocol supported
25
+- A Netdata Cloud account
26
+- Access to the Space as an administrator
27
+- Space needs to be on the Business plan or higher
28
+
29
+### Setting up Authorization Server
30
+Your server should follow the [full specification for OIDC](https://openid.net/specs/openid-connect-core-1_0.html).
31
+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.
32
+The access settings for your client are the following:
33
+| field | value |
34
+| :-- | :-- |
35
+| Root URL | https://app.netdata.cloud/ |
36
+| 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 |
37
+| Redirect URL | https://app.netdata.cloud/api/v2/auth/account/auth-server/callback |
38
+
39
+### Netdata Configuration Steps
40
+1. Click on the Space settings cog (located above your profile icon)
41
+2. Click on the **Authentication** tab
42
+3. On the OIDC card, click on **Configure**
43
+4. Fill in the required credentials:
44
+ - **Issuer URL** the Authorization Server Issuer URL, e.g. `https://my-auth-server.com/`
45
+ - **Client ID** the Client ID from the created client
46
+ - **Client Secret** the Client Secret from the created client
47
+ - **Authorization URL** the Authorization Server authorization URL, e.g. `https://my-auth-server.com/openid-connect/auth`
48
+ - **Token URL** the Authorization Server token URL, e.g. `https://my-auth-server.com/openid-connect/token`
49
+ - **User URL** the Authorization Server user info URL, e.g. `https://my-auth-server.com/openid-connect/userinfo`
50
+
51
+### Supported features
52
+* SP-initiated SSO (Single Sign-On)
53
+* IdP-initiated SSO
54
+
55
+### SP-initiated SSO
56
+
57
+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).
58
+
59
+
60
+### Reference
61
+https://openid.net/developers/how-connect-works/
62
+
63
+
integrations/integrations.js
+20
@@ -22303,6 +22303,26 @@ export const integrations = [
22303
"integration_type": "notification",
22304
"edit_link": "https://github.com/netdata/netdata/blob/master/src/health/notifications/twilio/metadata.yaml"
22305
},
22306
+ {
22307
+ "id": "oidc-authentication",
22308
+ "meta": {
22309
+ "name": "OIDC",
22310
+ "link": "https://netdata.cloud",
22311
+ "categories": [
22312
+ "auth"
22313
+ ],
22314
+ "icon_filename": "openid.svg"
22315
+ },
22316
+ "keywords": [
22317
+ "sso",
22318
+ "oidc"
22319
+ ],
22320
+ "overview": "# OIDC\n\nIntegrate your organization's Authorization Servers with Netdata to better manage your team's access controls to Netdata Cloud.\n",
22321
+ "setup": "## Setup\n\n### Prerequisites\n- Authorization Server with OIDC protocol supported\n- A Netdata Cloud account\n- Access to the Space as an administrator\n- Space needs to be on the Business plan or higher\n\n### Setting up Authorization Server\nYour server should follow the [full specification for OIDC](https://openid.net/specs/openid-connect-core-1_0.html).\nIn 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.\nThe access settings for your client are the following:\n| field | value |\n| :-- | :-- |\n| Root URL | https://app.netdata.cloud/ |\n| 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 |\n| Redirect URL | https://app.netdata.cloud/api/v2/auth/account/auth-server/callback |\n\n### Netdata Configuration Steps\n1. Click on the Space settings cog (located above your profile icon)\n2. Click on the **Authentication** tab\n3. On the OIDC card, click on **Configure**\n4. Fill in the required credentials:\n - **Issuer URL** the Authorization Server Issuer URL, e.g. `https://my-auth-server.com/`\n - **Client ID** the Client ID from the created client\n - **Client Secret** the Client Secret from the created client\n - **Authorization URL** the Authorization Server authorization URL, e.g. `https://my-auth-server.com/openid-connect/auth`\n - **Token URL** the Authorization Server token URL, e.g. `https://my-auth-server.com/openid-connect/token`\n - **User URL** the Authorization Server user info URL, e.g. `https://my-auth-server.com/openid-connect/userinfo`\n\n### Supported features\n* SP-initiated SSO (Single Sign-On)\n* IdP-initiated SSO\n\n### SP-initiated SSO\n\nIf 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).\n\n\n### Reference\nhttps://openid.net/developers/how-connect-works/\n\n",
22322
+ "integration_type": "authentication",
22323
+ "edit_link": "https://github.com/netdata/netdata/blob/master/integrations/cloud-authentication/metadata.yaml",
22324
+ "troubleshooting": ""
22325
+ },
22326
{
22327
"id": "okta-authentication",
22328
"meta": {
integrations/integrations.json
+20
@@ -22301,6 +22301,26 @@
22301
"integration_type": "notification",
22302
"edit_link": "https://github.com/netdata/netdata/blob/master/src/health/notifications/twilio/metadata.yaml"
22303
},
22304
+ {
22305
+ "id": "oidc-authentication",
22306
+ "meta": {
22307
+ "name": "OIDC",
22308
+ "link": "https://netdata.cloud",
22309
+ "categories": [
22310
+ "auth"
22311
+ ],
22312
+ "icon_filename": "openid.svg"
22313
+ },
22314
+ "keywords": [
22315
+ "sso",
22316
+ "oidc"
22317
+ ],
22318
+ "overview": "# OIDC\n\nIntegrate your organization's Authorization Servers with Netdata to better manage your team's access controls to Netdata Cloud.\n",
22319
+ "setup": "## Setup\n\n### Prerequisites\n- Authorization Server with OIDC protocol supported\n- A Netdata Cloud account\n- Access to the Space as an administrator\n- Space needs to be on the Business plan or higher\n\n### Setting up Authorization Server\nYour server should follow the [full specification for OIDC](https://openid.net/specs/openid-connect-core-1_0.html).\nIn 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.\nThe access settings for your client are the following:\n| field | value |\n| :-- | :-- |\n| Root URL | https://app.netdata.cloud/ |\n| 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 |\n| Redirect URL | https://app.netdata.cloud/api/v2/auth/account/auth-server/callback |\n\n### Netdata Configuration Steps\n1. Click on the Space settings cog (located above your profile icon)\n2. Click on the **Authentication** tab\n3. On the OIDC card, click on **Configure**\n4. Fill in the required credentials:\n - **Issuer URL** the Authorization Server Issuer URL, e.g. `https://my-auth-server.com/`\n - **Client ID** the Client ID from the created client\n - **Client Secret** the Client Secret from the created client\n - **Authorization URL** the Authorization Server authorization URL, e.g. `https://my-auth-server.com/openid-connect/auth`\n - **Token URL** the Authorization Server token URL, e.g. `https://my-auth-server.com/openid-connect/token`\n - **User URL** the Authorization Server user info URL, e.g. `https://my-auth-server.com/openid-connect/userinfo`\n\n### Supported features\n* SP-initiated SSO (Single Sign-On)\n* IdP-initiated SSO\n\n### SP-initiated SSO\n\nIf 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).\n\n\n### Reference\nhttps://openid.net/developers/how-connect-works/\n\n",
22320
+ "integration_type": "authentication",
22321
+ "edit_link": "https://github.com/netdata/netdata/blob/master/integrations/cloud-authentication/metadata.yaml",
22322
+ "troubleshooting": ""
22323
+ },
22324
{
22325
"id": "okta-authentication",
22326
"meta": {