Add role, team, and org attributes to SSO attributes table (#18295)

* add attributes to table

* add optional tag
This commit is contained in:
Stephanie Aurelio 2023-09-28 15:18:39 -07:00 committed by GitHub
parent fbad991aad
commit d7e8a0cfd1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 1 deletions

View File

@ -1,11 +1,14 @@
{{ $product_name := "Docker Hub" }} {{ $product_name := "Docker Hub" }}
{{ $sso_config_link := "[configuring SSO](/single-sign-on/configure/)" }} {{ $sso_config_link := "[configuring SSO](/single-sign-on/configure/)" }}
{{ $role_mapping_link := "[Set up role mapping](docker-hub/scim.md#set-up-role-mapping)" }}
{{ if eq (.Get "product") "admin" }} {{ if eq (.Get "product") "admin" }}
{{ $product_name = "Docker Admin" }} {{ $product_name = "Docker Admin" }}
{{ $sso_config_link = "[configuring SSO](/admin/organization/security-settings/sso-configuration/)" }} {{ $sso_config_link = "[configuring SSO](/admin/organization/security-settings/sso-configuration/)" }}
{{ $role_mapping_link = "[Set up role mapping](admin/organization/security-settings/scim.md#set-up-role-mapping)" }}
{{ if eq (.Get "layer") "company" }} {{ if eq (.Get "layer") "company" }}
{{ $sso_config_link = "[configuring SSO](/admin/company/settings/sso-configuration/)" }} {{ $sso_config_link = "[configuring SSO](/admin/company/settings/sso-configuration/)" }}
{{ $role_mapping_link = "[Set up role mapping](admin/company/settings/scim.md#set-up-role-mapping)" }}
{{ end }} {{ end }}
{{ end }} {{ end }}
@ -39,11 +42,16 @@ When a user signs in using SSO, Docker obtains the following attributes from the
If you use SAML for your SSO connection, Docker obtains these attributes from the SAML assertion message. Your IdP may use different naming for SAML attributes than those listed above. The following table lists the possible SAML attributes that can be present in order for your SSO connection to work. If you use SAML for your SSO connection, Docker obtains these attributes from the SAML assertion message. Your IdP may use different naming for SAML attributes than those listed above. The following table lists the possible SAML attributes that can be present in order for your SSO connection to work.
You can also configure attributes to override default values, such as default team or organization. See {{ $role_mapping_link }}.
| SSO attribute | SAML assertion message attributes | | SSO attribute | SAML assertion message attributes |
| ---------------- | ------------------------- | | ---------------- | ------------------------- |
| Email address | `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier"`, `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn"`, `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress"`, `email` | | Email address | `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier"`, `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn"`, `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress"`, `email` |
| Full name | `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name"`, `name`, `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname"`, `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname"` | | Full name | `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name"`, `name`, `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname"`, `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname"` |
| Groups (optional) | `"http://schemas.xmlsoap.org/claims/Group"`, `"http://schemas.microsoft.com/ws/2008/06/identity/claims/groups"`, `Groups`, `groups` | | Groups (optional) | `"http://schemas.xmlsoap.org/claims/Group"`, `"http://schemas.microsoft.com/ws/2008/06/identity/claims/groups"`, `Groups`, `groups` |
| Docker Org (optional) | `dockerOrg` |
| Docker Team (optional) | `dockerTeam` |
| Docker Role (optional) | `dockerRole` |
> **Important** > **Important**
> >