mirror of
https://github.com/pomerium/pomerium.git
synced 2025-05-10 07:37:33 +02:00
ping: add documentation (#1976)
* ping: add documentation * Update docs/docs/identity-providers/ping.md Co-authored-by: bobby <1544881+desimone@users.noreply.github.com> * Update docs/docs/identity-providers/ping.md Co-authored-by: bobby <1544881+desimone@users.noreply.github.com> * use yaml for config Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
This commit is contained in:
parent
a5731f7d92
commit
07e150a5af
6 changed files with 72 additions and 0 deletions
|
@ -108,6 +108,7 @@ module.exports = {
|
|||
"identity-providers/google",
|
||||
"identity-providers/okta",
|
||||
"identity-providers/one-login",
|
||||
"identity-providers/ping",
|
||||
],
|
||||
},
|
||||
{
|
||||
|
|
BIN
docs/docs/identity-providers/img/ping-add-application.png
Normal file
BIN
docs/docs/identity-providers/img/ping-add-application.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 130 KiB |
BIN
docs/docs/identity-providers/img/ping-add-worker.png
Normal file
BIN
docs/docs/identity-providers/img/ping-add-worker.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 133 KiB |
BIN
docs/docs/identity-providers/img/ping-configuration.png
Normal file
BIN
docs/docs/identity-providers/img/ping-configuration.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 141 KiB |
BIN
docs/docs/identity-providers/img/ping-worker-configuration.png
Normal file
BIN
docs/docs/identity-providers/img/ping-worker-configuration.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 119 KiB |
71
docs/docs/identity-providers/ping.md
Normal file
71
docs/docs/identity-providers/ping.md
Normal file
|
@ -0,0 +1,71 @@
|
|||
---
|
||||
title: Ping
|
||||
lang: en-US
|
||||
sidebarDepth: 0
|
||||
meta:
|
||||
- name: keywords
|
||||
content: ping oidc
|
||||
---
|
||||
|
||||
# Ping
|
||||
|
||||
To use the Ping identity provider, first go to the [Ping One](https://console.pingone.com) console.
|
||||
|
||||
## Create OpenID Connect App
|
||||
|
||||
Click **Connections** in the side menu, select **Applications** and click **Add Application**
|
||||
|
||||

|
||||
|
||||
Name the application and use the Pomerium authenticate redirect URL. For example: `https://authenticate.localhost.pomerium.io/oauth2/callback`.
|
||||
|
||||
Underneath `Configuration` there are several options which will be used in the Pomerium configuration:
|
||||
|
||||
* The `idp_provider` is set to `ping`.
|
||||
* `Issuer`: used as the `idp_provider_url` (e.g. `https://auth.pingone.com/720dbe8a-83ed-48e1-9988-9928301ae668/as`)
|
||||
* `Client ID`: used as the `idp_client_id`
|
||||
* `Client Secret`: used as the `idp_client_secret`
|
||||
|
||||

|
||||
|
||||
## Service Account
|
||||
|
||||
To use `allowed_groups` in a policy, an `idp_service_account` needs to be set in the Pomerium configuration. The service account for Ping uses a **different** application and client ID and client secret from the one configured above.
|
||||
|
||||
Click **Add Application**, but this time select **Worker**/**Worker App**.
|
||||
|
||||

|
||||
|
||||
This application's **Client ID** and **Client Secret** will be used as the service account in Pomerium.
|
||||
|
||||

|
||||
|
||||
The format of the service account is a JSON encoded object with `client_id` and `client_secret` properties:
|
||||
|
||||
```yaml
|
||||
idp_service_account: |
|
||||
{
|
||||
"client_id": "WORKER_CLIENT_ID_HERE",
|
||||
"client_secret": "WORKER_CLIENT_SECRET_HERE"
|
||||
}
|
||||
```
|
||||
|
||||
A base64 encoded JSON object is also supported:
|
||||
|
||||
```yaml
|
||||
idp_service_account: ICB7CiAgICAiY2xpZW50X2lkIjogIldPUktFUl9DTElFTlRfSURfSEVSRSIsCiAgICAiY2xpZW50X3NlY3JldCI6ICJXT1JLRVJfQ0xJRU5UX1NFQ1JFVF9IRVJFIgogIH0K
|
||||
```
|
||||
|
||||
## Pomerium Configuration
|
||||
|
||||
```yaml
|
||||
idp_provider: "ping"
|
||||
idp_provider_url: "https://auth.pingone.com/720dbe8a-83ed-48e1-9988-9928301ae668/as"
|
||||
idp_client_id: "CLIENT_ID"
|
||||
idp_client_secret: "CLIENT_SECRET"
|
||||
idp_service_account: |
|
||||
{
|
||||
"client_id": "WORKER_CLIENT_ID",
|
||||
"client_secret": "WORKER_CLIENT_SECRET"
|
||||
}
|
||||
```
|
Loading…
Add table
Add a link
Reference in a new issue