Skip to content

Commit 0b62f8b

Browse files
committed
update saml docs with examples
1 parent 966e34e commit 0b62f8b

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

docs/content/admin/sso/PRO__saml.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,19 @@ DefectDojo can use the SAML assertion to automatically assign users to [User Gro
4141

4242
The **Group Name Attribute** field specifies which attribute in the SAML assertion contains the user's group memberships. When a user logs in, DefectDojo reads this attribute and assigns the user to any matching groups. To limit which groups from the assertion are considered, use the **Group Limiter Regex Expression** field.
4343

44+
The value must match the attribute name your Identity Provider emits in the assertion exactly, including any namespace prefix. A short, friendly name like `groups` will only work if your IdP is configured to emit that literal attribute name — many IdPs use a fully qualified claim URI instead.
45+
46+
### Group Name Attribute by Identity Provider
47+
48+
| Identity Provider | Default attribute name to use |
49+
|---|---|
50+
| **Entra ID / Azure AD** | `http://schemas.microsoft.com/ws/2008/06/identity/claims/groups` |
51+
| **Okta** | `groups` (the attribute name you configured on the SAML app's Group Attribute Statement) |
52+
| **Keycloak** | `groups` (or whatever you set as the "SAML Attribute Name" on the Group List mapper) |
53+
| **PingFederate / generic** | Whatever value you configured on the IdP side — check your IdP's assertion before assuming `groups` |
54+
55+
If group mapping appears to do nothing — users log in successfully but no groups are created or assigned — the most common cause is a mismatch between this field and the attribute name your IdP is actually sending. Enable **Enable SAML Debugging** (see [Additional Options](#additional-options)) to see the raw attributes coming back from the IdP.
56+
4457
If no group with a matching name exists, DefectDojo will automatically create one. Note that a newly created group will not have any permissions configured — those can be set later by a Superuser.
4558

4659
To activate group mapping, check the **Enable Group Mapping** checkbox at the bottom of the form.

0 commit comments

Comments
 (0)