Commit 0facc40f authored by Andrew Fontaine's avatar Andrew Fontaine

Merge branch 'eread/improve-saml-assertions-documentation' into 'master'

Improve SAML assertions documentation

See merge request gitlab-org/gitlab!74364
parents f6a2a352 f51e8107
...@@ -29,8 +29,7 @@ If required, you can find [a glossary of common terms](../../../integration/saml ...@@ -29,8 +29,7 @@ If required, you can find [a glossary of common terms](../../../integration/saml
Alternatively GitLab provides [metadata XML configuration](#metadata-configuration). Alternatively GitLab provides [metadata XML configuration](#metadata-configuration).
See [specific identity provider documentation](#providers) for more details. See [specific identity provider documentation](#providers) for more details.
1. Configure the SAML response to include a NameID that uniquely identifies each user. 1. Configure the SAML response to include a NameID that uniquely identifies each user.
1. Configure [required assertions](#assertions) at minimum containing 1. Configure the required [user attributes](#user-attributes), ensuring you include the user's email address.
the user's email address.
1. While the default is enabled for most SAML providers, please ensure the app is set to have service provider 1. While the default is enabled for most SAML providers, please ensure the app is set to have service provider
initiated calls in order to link existing GitLab accounts. initiated calls in order to link existing GitLab accounts.
1. Once the identity provider is set up, move on to [configuring GitLab](#configuring-gitlab). 1. Once the identity provider is set up, move on to [configuring GitLab](#configuring-gitlab).
...@@ -63,15 +62,16 @@ Once users have signed into GitLab using the SSO SAML setup, changing the `NameI ...@@ -63,15 +62,16 @@ Once users have signed into GitLab using the SSO SAML setup, changing the `NameI
We recommend setting the NameID format to `Persistent` unless using a field (such as email) that requires a different format. We recommend setting the NameID format to `Persistent` unless using a field (such as email) that requires a different format.
Most NameID formats can be used, except `Transient` due to the temporary nature of this format. Most NameID formats can be used, except `Transient` due to the temporary nature of this format.
### Assertions ### User attributes
For users to be created with the right information with the improved [user access and management](#user-access-and-management), To create users with the correct information for improved [user access and management](#user-access-and-management),
the user details need to be passed to GitLab as SAML assertions. the user's details must be passed to GitLab as attributes in the SAML assertion. At a minimum, the user's email address
must be specified as an attribute named `email` or `mail`.
At a minimum, the user's email address *must* be specified as an assertion named `email` or `mail`. GitLab.com supports the following attributes:
See [the assertions list](../../../integration/saml.md#assertions) for other available claims.
In addition to the attributes in the linked assertions list, GitLab.com supports `username` - `username` or `nickname`. We recommend you configure only one of these.
and `nickname` attributes. - The [attributes also available](../../../integration/saml.md#assertions) to self-managed GitLab instances.
### Metadata configuration ### Metadata configuration
......
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
%li %li
= _("During this process, you’ll be asked for URLs from GitLab’s side. Use the URLs shown below.") = _("During this process, you’ll be asked for URLs from GitLab’s side. Use the URLs shown below.")
%li %li
= (_("Set up assertions/attributes/claims (email, first_name, last_name) and NameID according to %{docsLinkStart}the documentation %{icon}%{docsLinkEnd}") % { icon: sprite_icon('external-link'), docsLinkStart: "<a href='#{help_page_path('user/group/saml_sso/index.md', anchor: 'assertions')}' target='_blank'>", docsLinkEnd: '</a>' }).html_safe = (_("Set up assertions/attributes/claims (email, first_name, last_name) and NameID according to %{docsLinkStart}the documentation %{icon}%{docsLinkEnd}") % { icon: sprite_icon('external-link'), docsLinkStart: "<a href='#{help_page_path('user/group/saml_sso/index.md', anchor: 'user-attributes')}' target='_blank' rel='noopener noreferrer'>", docsLinkEnd: '</a>' }).html_safe
%li %li
= html_escape(_("Fill in the fields below, turn on %{strong_open}Enable SAML authentication for this group%{strong_close}, and press %{strong_open}Save changes%{strong_close}")) % { strong_open: '<strong>'.html_safe, strong_close: '</strong>'.html_safe } = html_escape(_("Fill in the fields below, turn on %{strong_open}Enable SAML authentication for this group%{strong_close}, and press %{strong_open}Save changes%{strong_close}")) % { strong_open: '<strong>'.html_safe, strong_close: '</strong>'.html_safe }
%li %li
......
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