Merge pull request #4631 from Infisical/daniel/pingone-oidc-docs
docs: pingone oidc
@@ -221,6 +221,7 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"documentation/platform/sso/auth0-oidc",
|
"documentation/platform/sso/auth0-oidc",
|
||||||
|
"documentation/platform/sso/pingone-oidc",
|
||||||
{
|
{
|
||||||
"group": "General OIDC",
|
"group": "General OIDC",
|
||||||
"pages": [
|
"pages": [
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ description: "Learn how to configure Auth0 OIDC for Infisical SSO."
|
|||||||
<Info>
|
<Info>
|
||||||
Auth0 OIDC SSO is a paid feature. If you're using Infisical Cloud, then it is
|
Auth0 OIDC SSO is a paid feature. If you're using Infisical Cloud, then it is
|
||||||
available under the **Pro Tier**. If you're self-hosting Infisical, then you
|
available under the **Pro Tier**. If you're self-hosting Infisical, then you
|
||||||
should contact sales@infisical.com to purchase an enterprise license to use
|
should contact sales@infisical.com to purchase a self-hosted license to use
|
||||||
it.
|
it.
|
||||||
</Info>
|
</Info>
|
||||||
|
|
||||||
@@ -55,7 +55,7 @@ description: "Learn how to configure Auth0 OIDC for Infisical SSO."
|
|||||||
<Step title="Enable OIDC in Infisical">
|
<Step title="Enable OIDC in Infisical">
|
||||||
Enabling OIDC allows members in your organization to log into Infisical via Auth0.
|
Enabling OIDC allows members in your organization to log into Infisical via Auth0.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
</Step>
|
</Step>
|
||||||
<Step title="Enforce OIDC SSO in Infisical">
|
<Step title="Enforce OIDC SSO in Infisical">
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ description: "Learn how to configure OIDC for Infisical SSO with any OIDC-compli
|
|||||||
<Info>
|
<Info>
|
||||||
OIDC SSO is a paid feature. If you're using Infisical Cloud, then it is
|
OIDC SSO is a paid feature. If you're using Infisical Cloud, then it is
|
||||||
available under the **Pro Tier**. If you're self-hosting Infisical, then you
|
available under the **Pro Tier**. If you're self-hosting Infisical, then you
|
||||||
should contact sales@infisical.com to purchase an enterprise license to use
|
should contact sales@infisical.com to purchase a self-hosted license to use
|
||||||
it.
|
it.
|
||||||
</Info>
|
</Info>
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ description: "Learn how to configure Keycloak OIDC for Infisical SSO."
|
|||||||
<Info>
|
<Info>
|
||||||
Keycloak OIDC SSO is a paid feature. If you're using Infisical Cloud, then it
|
Keycloak OIDC SSO is a paid feature. If you're using Infisical Cloud, then it
|
||||||
is available under the **Pro Tier**. If you're self-hosting Infisical, then
|
is available under the **Pro Tier**. If you're self-hosting Infisical, then
|
||||||
you should contact sales@infisical.com to purchase an enterprise license to
|
you should contact sales@infisical.com to purchase a self-hosted license to
|
||||||
use it.
|
use it.
|
||||||
</Info>
|
</Info>
|
||||||
|
|
||||||
@@ -82,7 +82,7 @@ description: "Learn how to configure Keycloak OIDC for Infisical SSO."
|
|||||||
<Step title="Enable OIDC SSO in Infisical">
|
<Step title="Enable OIDC SSO in Infisical">
|
||||||
Enabling OIDC SSO allows members in your organization to log into Infisical via Keycloak.
|
Enabling OIDC SSO allows members in your organization to log into Infisical via Keycloak.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
</Step>
|
</Step>
|
||||||
<Step title="Enforce OIDC SSO in Infisical">
|
<Step title="Enforce OIDC SSO in Infisical">
|
||||||
|
|||||||
108
docs/documentation/platform/sso/pingone-oidc.mdx
Normal file
@@ -0,0 +1,108 @@
|
|||||||
|
---
|
||||||
|
title: "PingOne OIDC"
|
||||||
|
description: "Learn how to configure PingOne OIDC for Infisical SSO."
|
||||||
|
---
|
||||||
|
|
||||||
|
<Info>
|
||||||
|
PingOne OIDC SSO is a paid feature. If you're using Infisical Cloud, then it is
|
||||||
|
available under the **Pro Tier**. If you're self-hosting Infisical, then you
|
||||||
|
should contact sales@infisical.com to purchase a self-hosted license to use
|
||||||
|
it.
|
||||||
|
</Info>
|
||||||
|
|
||||||
|
<Steps>
|
||||||
|
<Step title="Setup application in PingOne">
|
||||||
|
1.1. From the Application's Page, create a new OIDC Web App application.
|
||||||
|

|
||||||
|
|
||||||
|
1.2. Enable the application by pressing the "Enable" toggle.
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
1.3. In the Application "Configuration" tab, press the "Edit" pencil icon to configure the application callback URI.
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
1.4 Set the Redirect URL to `https://app.infisical.com/api/v1/sso/oidc/callback` and press the "Save" button.
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
<Info>
|
||||||
|
If you're self-hosting Infisical, then you will want to replace https://app.infisical.com with your own domain.
|
||||||
|
</Info>
|
||||||
|
|
||||||
|
|
||||||
|
1.5 After configuring the redirect URL, go to the "Attribute Mappings" tab and press the "Edit" pencil icon to configure the attribute mappings.
|
||||||
|

|
||||||
|
|
||||||
|
1.6 Map the following attributes:
|
||||||
|
- `email` -> `Email Address`
|
||||||
|
- `name` -> `Username`
|
||||||
|

|
||||||
|
|
||||||
|
Once done, press the "Save" button.
|
||||||
|
|
||||||
|
</Step>
|
||||||
|
<Step title="Retrieve Identity Provider (IdP) Information from PingOne">
|
||||||
|
2.1. Open the "Overview" tab and copy the **Client ID** and **Client Secret**.
|
||||||
|

|
||||||
|
|
||||||
|
2.2. Still in the "Overview" tab, scroll down to the Connection Details section and retrieve the **OIDC Discovery Endpoint**.
|
||||||
|

|
||||||
|
|
||||||
|
Keep these values handy as we will need them in the next steps.
|
||||||
|
|
||||||
|
</Step>
|
||||||
|
<Step title="Finish configuring OIDC in Infisical">
|
||||||
|
3.1. Back in Infisical, head to the **Single Sign-On (SSO)** page and select the **General** tab. Click **Connect** for **OIDC**.
|
||||||
|

|
||||||
|
|
||||||
|
3.2. For configuration type, select **Discovery URL**. Then, set **Discovery Document URL**, **Client ID**, and **Client Secret** from step 2.1 and 2.2.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
<Info>
|
||||||
|
Currently, the following JWT signature algorithms are supported: RS256, RS512, HS256, and EdDSA
|
||||||
|
</Info>
|
||||||
|
|
||||||
|
Once you've done that, press **Update** to complete the required configuration.
|
||||||
|
|
||||||
|
</Step>
|
||||||
|
<Step title="Enable OIDC in Infisical">
|
||||||
|
Enabling OIDC allows members in your organization to log into Infisical via PingOne
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
</Step>
|
||||||
|
<Step title="Enforce OIDC SSO in Infisical">
|
||||||
|
Enforcing OIDC SSO ensures that members in your organization can only access Infisical
|
||||||
|
by logging into the organization via PingOne.
|
||||||
|
|
||||||
|
To enforce OIDC SSO, you're required to test out the OpenID connection by successfully authenticating at least one PingOne user with Infisical.
|
||||||
|
Once you've completed this requirement, you can toggle the **Enforce OIDC SSO** button to enforce OIDC SSO.
|
||||||
|
|
||||||
|
<Warning>
|
||||||
|
We recommend ensuring that your account is provisioned using the application in PingOne
|
||||||
|
prior to enforcing OIDC SSO to prevent any unintended issues.
|
||||||
|
</Warning>
|
||||||
|
<Info>
|
||||||
|
In case of a lockout, an organization admin can use the [Admin Login Portal](https://infisical.com/docs/documentation/platform/sso/overview#admin-login-portal) in the `/login/admin` path e.g. https://app.infisical.com/login/admin.
|
||||||
|
</Info>
|
||||||
|
</Step>
|
||||||
|
</Steps>
|
||||||
|
|
||||||
|
<Tip>
|
||||||
|
If you are only using one organization on your Infisical instance, you can configure a default organization in the [Server Admin Console](../admin-panel/server-admin#default-organization) to expedite OIDC login.
|
||||||
|
</Tip>
|
||||||
|
|
||||||
|
<Note>
|
||||||
|
If you're configuring OIDC SSO on a self-hosted instance of Infisical, make
|
||||||
|
sure to set the `AUTH_SECRET` and `SITE_URL` environment variable for it to
|
||||||
|
work:
|
||||||
|
<div class="height:1px;"/>
|
||||||
|
- `AUTH_SECRET`: A secret key used for signing and verifying JWT. This
|
||||||
|
can be a random 32-byte base64 string generated with `openssl rand -base64
|
||||||
|
32`.
|
||||||
|
<div class="height:1px;"/>
|
||||||
|
- `SITE_URL`: The absolute URL of your self-hosted instance of Infisical including the protocol (e.g. https://app.infisical.com)
|
||||||
|
</Note>
|
||||||
|
Before Width: | Height: | Size: 797 KiB After Width: | Height: | Size: 797 KiB |
|
Before Width: | Height: | Size: 797 KiB |
BIN
docs/images/sso/pingone-oidc/infisical-configure-oidc.png
Normal file
|
After Width: | Height: | Size: 176 KiB |
BIN
docs/images/sso/pingone-oidc/pingone-create-application.png
Normal file
|
After Width: | Height: | Size: 191 KiB |
|
After Width: | Height: | Size: 184 KiB |
|
After Width: | Height: | Size: 218 KiB |
|
After Width: | Height: | Size: 216 KiB |
|
After Width: | Height: | Size: 195 KiB |
BIN
docs/images/sso/pingone-oidc/pingone-enable-application.png
Normal file
|
After Width: | Height: | Size: 222 KiB |
BIN
docs/images/sso/pingone-oidc/pingone-overview-credentials.png
Normal file
|
After Width: | Height: | Size: 236 KiB |
|
After Width: | Height: | Size: 282 KiB |