mirror of
https://github.com/pomerium/pomerium.git
synced 2025-06-03 19:32:48 +02:00
docs: update GitHub documentation for service account (#967)
* docs: update GitHub documentation for service account * add read:org permission
This commit is contained in:
parent
8362f18355
commit
f11c5ba172
2 changed files with 16 additions and 2 deletions
|
@ -12,7 +12,7 @@ meta:
|
|||
This document describes the use of GitHub as an identity provider for Pomerium.
|
||||
|
||||
Before we proceed, please be aware that [GitHub API] does not support [OpenID Connect], just [OAuth 2.0].
|
||||
For this reason, it was challenging to implement revocation of a user's **Access Token** (a string representing the granted permissions) when they sign out from Pomerium's dashboard.
|
||||
For this reason, it was challenging to implement revocation of a user's **Access Token** (a string representing the granted permissions) when they sign out from Pomerium's dashboard.
|
||||
|
||||
In addition, the teams of the organization(s) a user belongs to, will be used as groups on Pomerium.
|
||||
|
||||
|
@ -22,7 +22,7 @@ In addition, the teams of the organization(s) a user belongs to, will be used as
|
|||
|
||||
2. Navigate to your profile using the avatar on the navigation bar.
|
||||
|
||||
3. Go to your settings.
|
||||
3. Go to your settings.
|
||||
|
||||

|
||||
|
||||
|
@ -41,6 +41,19 @@ Authorization callback URL | `https://${authenticate_service_url}/oauth2/callba
|
|||
|
||||
After the application had been created, you will have access to the credentials, the **Client ID** and **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 GitHub should be a personal access token with `read:org` permissions, which can be created at [github.com/settings/tokens/new](https://github.com/settings/tokens/new).
|
||||
|
||||

|
||||
|
||||
The format of the `idp_service_account` for GitHub is a base64-encoded JSON document:
|
||||
|
||||
```json
|
||||
{
|
||||
"username": "YOUR_GITHUB_USERNAME",
|
||||
"personal_access_token": "GENERATED_GITHUB_ACCESS_TOKEN"
|
||||
}
|
||||
```
|
||||
|
||||
## Pomerium Configuration
|
||||
|
||||
|
@ -51,6 +64,7 @@ authenticate_service_url: https://authenticate.localhost.pomerium.io
|
|||
idp_provider: "github"
|
||||
idp_client_id: "REDACTED" // github application ID
|
||||
idp_client_secret: "REDACTED" // github application secret
|
||||
idp_service_account: "REDACTED" // github service account (personal access token)
|
||||
```
|
||||
|
||||
Whenever a user tries to access your application integrated with Pomerium, they will be presented with a sign-on page as below:
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 215 KiB |
Loading…
Add table
Add a link
Reference in a new issue