Commit f9307936 authored by Ben Bodenmiller's avatar Ben Bodenmiller Committed by Mike Jang

Docs: SAML external groups are supported in free edition

parent 2a62b9da
...@@ -168,6 +168,16 @@ These groups are checked on each SAML login and user attributes updated as neces ...@@ -168,6 +168,16 @@ These groups are checked on each SAML login and user attributes updated as neces
This feature **does not** allow you to This feature **does not** allow you to
automatically add users to GitLab [Groups](../user/group/index.md). automatically add users to GitLab [Groups](../user/group/index.md).
Support for these groups depends on your [subscription](https://about.gitlab.com/pricing/)
and whether you've installed [GitLab Enterprise Edition (EE)](https://about.gitlab.com/install/).
| Group | Tier | GitLab Enterprise Edition (EE) Only? |
|------------------------------|--------------------|--------------------------------------|
| [Required](#required-groups) | **(FREE SELF)** | Yes |
| [External](#external-groups) | **(FREE SELF)** | No |
| [Admin](#admin-groups) | **(FREE SELF)** | Yes |
| [Auditor](#auditor-groups) | **(PREMIUM SELF)** | Yes |
### Requirements ### Requirements
First you need to tell GitLab where to look for group information. For this you First you need to tell GitLab where to look for group information. For this you
...@@ -189,7 +199,7 @@ The name of the attribute can be anything you like, but it must contain the grou ...@@ -189,7 +199,7 @@ The name of the attribute can be anything you like, but it must contain the grou
to which a user belongs. In order to tell GitLab where to find these groups, you need to which a user belongs. In order to tell GitLab where to find these groups, you need
to add a `groups_attribute:` element to your SAML settings. to add a `groups_attribute:` element to your SAML settings.
### Required groups **(PREMIUM SELF)** ### Required groups **(FREE SELF)**
Your IdP passes Group Information to the SP (GitLab) in the SAML Response. You need to configure GitLab to identify: Your IdP passes Group Information to the SP (GitLab) in the SAML Response. You need to configure GitLab to identify:
...@@ -215,7 +225,7 @@ Example: ...@@ -215,7 +225,7 @@ Example:
} } } }
``` ```
### External groups **(PREMIUM SELF)** ### External groups **(FREE SELF)**
SAML login supports automatic identification on whether a user should be considered an [external user](../user/permissions.md#external-users). This is based on the user's group membership in the SAML identity provider. SAML login supports automatic identification on whether a user should be considered an [external user](../user/permissions.md#external-users). This is based on the user's group membership in the SAML identity provider.
...@@ -233,7 +243,7 @@ SAML login supports automatic identification on whether a user should be conside ...@@ -233,7 +243,7 @@ SAML login supports automatic identification on whether a user should be conside
} } } }
``` ```
### Admin groups **(PREMIUM SELF)** ### Admin groups **(FREE SELF)**
The requirements are the same as the previous settings, your IdP needs to pass Group information to GitLab, you need to tell The requirements are the same as the previous settings, your IdP needs to pass Group information to GitLab, you need to tell
GitLab where to look for the groups in the SAML response, and which group(s) should be GitLab where to look for the groups in the SAML response, and which group(s) should be
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment