Skip to content

Commit daae8b7

Browse files
authored
Merge pull request sameersbn#2841 from massej/patch-1
Added - OAuth2 Generic - missing label and scope variables
2 parents 3033b64 + 8bcb068 commit daae8b7

File tree

5 files changed

+17
-1
lines changed

5 files changed

+17
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -718,7 +718,7 @@ Also you can configure v2 endpoint (`azure_activedirectory_v2`) by using `OAUTH_
718718

719719
To enable the Generic OAuth2 provider, you must register your application with your provider. You also need to confirm OAuth2 provider app's ID and secret, the client options and the user's response structure.
720720

721-
As an example this code has been tested with Keycloak, with the following variables: `OAUTH2_GENERIC_APP_ID`, `OAUTH2_GENERIC_APP_SECRET`, `OAUTH2_GENERIC_CLIENT_SITE`, `OAUTH2_GENERIC_CLIENT_USER_INFO_URL`, `OAUTH2_GENERIC_CLIENT_AUTHORIZE_URL`, `OAUTH2_GENERIC_CLIENT_TOKEN_URL`, `OAUTH2_GENERIC_CLIENT_END_SESSION_ENDPOINT`, `OAUTH2_GENERIC_ID_PATH`, `OAUTH2_GENERIC_USER_UID`, `OAUTH2_GENERIC_USER_NAME`, `OAUTH2_GENERIC_USER_EMAIL`, `OAUTH2_GENERIC_NAME`,
721+
As an example this code has been tested with Keycloak, with the following variables: `OAUTH2_GENERIC_APP_ID`, `OAUTH2_GENERIC_APP_SECRET`, `OAUTH2_GENERIC_CLIENT_SITE`, `OAUTH2_GENERIC_CLIENT_USER_INFO_URL`, `OAUTH2_GENERIC_CLIENT_AUTHORIZE_URL`, `OAUTH2_GENERIC_CLIENT_TOKEN_URL`, `OAUTH2_GENERIC_CLIENT_END_SESSION_ENDPOINT`, `OAUTH2_GENERIC_ID_PATH`, `OAUTH2_GENERIC_USER_UID`, `OAUTH2_GENERIC_USER_NAME`, `OAUTH2_GENERIC_USER_EMAIL`, `OAUTH2_GENERIC_AUTHORIZE_PARAMS_SCOPE`, `OAUTH2_GENERIC_LABEL` and `OAUTH2_GENERIC_NAME`.
722722

723723
See [GitLab documentation](https://docs.gitlab.com/ee/integration/oauth2_generic.html#sign-into-gitlab-with-almost-any-oauth2-provider) and [Omniauth-oauth2-generic documentation](https://gitlab.com/satorix/omniauth-oauth2-generic) for more details.
724724

@@ -2279,6 +2279,14 @@ The OAuth2 generic user name. No defaults
22792279

22802280
The OAuth2 generic user email. No defaults
22812281

2282+
##### `OAUTH2_GENERIC_AUTHORIZE_PARAMS_SCOPE`
2283+
2284+
The scope of your OAuth2 provider. No defaults
2285+
2286+
##### `OAUTH2_GENERIC_LABEL`
2287+
2288+
The label of your OAuth2 provider. No defaults
2289+
22822290
##### `OAUTH2_GENERIC_NAME`
22832291

22842292
The name of your OAuth2 provider. No defaults

assets/runtime/config/gitlabhq/gitlab.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1017,6 +1017,8 @@ production: &base
10171017
email: '{{OAUTH2_GENERIC_USER_EMAIL}}'
10181018
}
10191019
},
1020+
authorize_params: { scope: "{{OAUTH2_GENERIC_AUTHORIZE_PARAMS_SCOPE}}" },
1021+
label: '{{OAUTH2_GENERIC_LABEL}}',
10201022
name: '{{OAUTH2_GENERIC_NAME}}' }}
10211023
- { name: 'azure_oauth2',
10221024
args: {

assets/runtime/env-defaults

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -531,6 +531,8 @@ OAUTH2_GENERIC_ID_PATH=${OAUTH2_GENERIC_ID_PATH:-}
531531
OAUTH2_GENERIC_USER_UID=${OAUTH2_GENERIC_USER_UID:-}
532532
OAUTH2_GENERIC_USER_NAME=${OAUTH2_GENERIC_USER_NAME:-}
533533
OAUTH2_GENERIC_USER_EMAIL=${OAUTH2_GENERIC_USER_EMAIL:-}
534+
OAUTH2_GENERIC_AUTHORIZE_PARAMS_SCOPE=${OAUTH2_GENERIC_AUTHORIZE_PARAMS_SCOPE:-}
535+
OAUTH2_GENERIC_LABEL=${OAUTH2_GENERIC_LABEL:-}
534536
OAUTH2_GENERIC_NAME=${OAUTH2_GENERIC_NAME:-}
535537

536538
## ANALYTICS

assets/runtime/functions

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -722,6 +722,8 @@ gitlab_configure_oauth2_generic() {
722722
OAUTH2_GENERIC_USER_UID \
723723
OAUTH2_GENERIC_USER_NAME \
724724
OAUTH2_GENERIC_USER_EMAIL \
725+
OAUTH2_GENERIC_AUTHORIZE_PARAMS_SCOPE \
726+
OAUTH2_GENERIC_LABEL \
725727
OAUTH2_GENERIC_NAME
726728
else
727729
exec_as_git sed -i "/name: 'oauth2_generic'/,/{{OAUTH2_GENERIC_NAME}}/d" ${GITLAB_CONFIG}

contrib/docker-swarm/docker-compose.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,8 @@ services:
163163
- OAUTH2_GENERIC_USER_UID=
164164
- OAUTH2_GENERIC_USER_NAME=
165165
- OAUTH2_GENERIC_USER_EMAIL=
166+
- OAUTH2_GENERIC_AUTHORIZE_PARAMS_SCOPE=
167+
- OAUTH2_GENERIC_LABEL=
166168
- OAUTH2_GENERIC_NAME=
167169

168170
- OAUTH_AZURE_API_KEY=

0 commit comments

Comments
 (0)