Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
ddcf0dd4
Commit
ddcf0dd4
authored
Apr 02, 2021
by
Stan Hu
Committed by
Mike Jang
Apr 02, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Document OmniAuth provider names in a table
parent
09940835
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
39 additions
and
29 deletions
+39
-29
doc/integration/omniauth.md
doc/integration/omniauth.md
+39
-29
No files found.
doc/integration/omniauth.md
View file @
ddcf0dd4
...
...
@@ -22,40 +22,50 @@ of the configured mechanisms.
## Supported Providers
This is a list of the current supported OmniAuth providers. Before proceeding
on each provider's documentation, make sure to first read this document as it
contains some settings that are common for all providers.
-
[
GitHub
](
github.md
)
-
[
Bitbucket
](
bitbucket.md
)
-
[
GitLab.com
](
gitlab.md
)
-
[
Google
](
google.md
)
-
[
Facebook
](
facebook.md
)
-
[
Twitter
](
twitter.md
)
-
[
Shibboleth
](
shibboleth.md
)
-
[
SAML
](
saml.md
)
-
[
Crowd
](
../administration/auth/crowd.md
)
-
[
Azure
](
azure.md
)
-
[
Auth0
](
auth0.md
)
-
[
Authentiq
](
../administration/auth/authentiq.md
)
-
[
OAuth2Generic
](
oauth2_generic.md
)
-
[
JWT
](
../administration/auth/jwt.md
)
-
[
OpenID Connect
](
../administration/auth/oidc.md
)
-
[
Salesforce
](
salesforce.md
)
-
[
AWS Cognito
](
../administration/auth/cognito.md
)
This is a list of the current supported OmniAuth providers. Before proceeding on each provider's documentation,
make sure to first read this document as it contains some settings that are common for all providers.
|Provider documentation |OmniAuth provider name |
|-----------------------------------------------------------------|--------------------------|
|
[
Atlassian Crowd
](
../administration/auth/crowd.md
)
|
`crowd`
|
|
[
Atlassian
](
../administration/auth/atlassian.md
)
|
`atlassian_oauth2`
|
|
[
Auth0
](
auth0.md
)
|
`auth0`
|
|
[
Authentiq
](
../administration/auth/authentiq.md
)
|
`authentiq`
|
|
[
AWS Cognito
](
../administration/auth/cognito.md
)
|
`cognito`
|
|
[
Azure v2
](
azure.md#microsoft-azure-oauth2-omniauth-provider-v2
)
|
`azure_activedirectory_v2`
|
|
[
Azure v1
](
azure.md
)
|
`azure_oauth2`
|
|
[
Bitbucket Cloud
](
bitbucket.md
)
|
`bitbucket`
|
|
[
CAS
](
cas.md
)
|
`cas3`
|
|
[
Facebook
](
facebook.md
)
|
`facebook`
|
|
[
Generic OAuth2
](
oauth2_generic.md
)
|
`oauth2_generic`
|
|
[
GitHub
](
github.md
)
|
`github`
|
|
[
GitLab.com
](
gitlab.md
)
|
`gitlab`
|
|
[
Google
](
google.md
)
|
`google_oauth2`
|
|
[
JWT
](
../administration/auth/jwt.md
)
|
`jwt`
|
|
[
Kerberos
](
kerberos.md
)
|
`kerberos`
|
|
[
OpenID Connect
](
../administration/auth/oidc.md
)
|
`openid_connect`
|
|
[
Salesforce
](
salesforce.md
)
|
`salesforce`
|
|
[
SAML
](
saml.md
)
|
`saml`
|
|
[
Shibboleth
](
shibboleth.md
)
|
`shibboleth`
|
|
[
Twitter
](
twitter.md
)
|
`twitter`
|
## Initial OmniAuth Configuration
Before configuring individual OmniAuth providers there are a few global settings
that are in common for all providers that we need to consider.
The OmniAuth provider names from the table above are needed to configure a few global settings that are in common for all providers.
NOTE:
Starting from GitLab 11.4, OmniAuth is enabled by default. If you're using an
earlier version, you must explicitly enable it.
-
`allow_single_sign_on`
allows you to specify the providers you want to allow to
automatically create an account. It defaults to
`false`
. If
`false`
users must
be created manually or they can't sign in by using OmniAuth.
-
`allow_single_sign_on`
allows you to specify the providers that automatically
create a GitLab account. For example, if you wish to enable Azure (v2) and Google,
in Omnibus, specify a list of provider names:
```
ruby
gitlab_rails
[
'omniauth_allow_single_sign_on'
]
=
[
'azure_activedirectory_v2'
,
'google_oauth2'
]
```
The value defaults to
`false`
. If
`false`
users must be created manually, or they can't sign in by using OmniAuth.
-
`auto_link_ldap_user`
can be used if you have
[
LDAP / ActiveDirectory
](
../administration/auth/ldap/index.md
)
integration enabled. It defaults to
`false`
. When enabled, users automatically
created through an OmniAuth provider have their LDAP identity created in GitLab as well.
...
...
@@ -325,20 +335,20 @@ You can add the `auto_sign_in_with_provider` setting to your GitLab
configuration to redirect login requests to your OmniAuth provider for
authentication. This removes the need to click a button before actually signing in.
For example, when using the
Azure integration
, set the following to enable auto
For example, when using the
[
Azure v2 integration
](
azure.md#microsoft-azure-oauth2-omniauth-provider-v2
)
, set the following to enable auto
sign-in:
For Omnibus package:
```
ruby
gitlab_rails
[
'omniauth_auto_sign_in_with_provider'
]
=
'azure_
oauth
2'
gitlab_rails
[
'omniauth_auto_sign_in_with_provider'
]
=
'azure_
activedirectory_v
2'
```
For installations from source:
```
yaml
omniauth
:
auto_sign_in_with_provider
:
azure_
oauth
2
auto_sign_in_with_provider
:
azure_
activedirectory_v
2
```
Keep in mind that every sign-in attempt is redirected to the OmniAuth
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment