awatertrevi/infisical
1
0
Fork 0
mirror of https://github.com/awatertrevi/infisical.git synced 2026-09-22 13:39:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation: add general oidc group membership mapping documentation

Browse Source
This commit is contained in:
Scott Wilson
2025-05-14 14:22:35 -07:00
parent 6188de43e4
commit 18e3d132a2
3 changed files with 60 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
docs/documentation/platform/sso/general-oidc/group-membership-mapping.mdx Normal file
View File

@@ -0,0 +1,52 @@
---
title: "General OIDC Group Membership Mapping"
sidebarTitle: "Group Membership Mapping"
description: "Learn how to sync OIDC group members to matching groups in Infisical."
---
You can have Infisical automatically sync group
memberships between your OIDC provider and Infisical by configuring a `groups` claim on your provider tokens.
When a user logs in via OIDC, they will be added to Infisical groups that are present in their OIDC `groups` claim,
and removed from any Infisical groups not present in the claim.
<Info>
When enabled, manual
management of Infisical group memberships will be disabled.
</Info>
<Warning>
Group membership changes in your OIDC provider only sync with Infisical when a
user logs in via OIDC. For example, if you remove a user from a group in your OIDC provider,
this change will not be reflected in Infisical until their next OIDC login.
To ensure this behavior, Infisical recommends enabling Enforce OIDC SSO in the OIDC settings.
</Warning>
<Steps>
<Step title="Configure a groups claim in your OIDC provider">
1. To enable OIDC Group Membership Mapping, you must configure a `groups` claim in your OIDC provider with the following format.
```json
{
// "email": "john@provider.com",
// "given_name": "John",
// ...other claims
"groups": ["Billing Group", "Sales Group"]
}
```
<Note>
Setup varies between OIDC providers. Please refer to your OIDC provider's documentation for more information.
</Note>
</Step>
<Step title="Setup groups in Infisical and enable OIDC Group Membership Mapping">
2.1. In Infisical, create any groups you would like to sync users to. Make sure the name of the Infisical group is an exact match of the OIDC group name.
![OIDC general infisical group](/images/sso/keycloak-oidc/group-membership-mapping/create-infisical-group.png)
2.2. Next, enable **OIDC Group Membership Mapping** on the **Single Sign-On (SSO)** page under the **General** tab.
![OIDC general enable group membership mapping](/images/sso/keycloak-oidc/group-membership-mapping/enable-group-membership-mapping.png)
2.3. The next time a user logs in they will be synced to their matching OIDC groups.
![OIDC general synced users](/images/sso/keycloak-oidc/group-membership-mapping/synced-users.png)
</Step>
</Steps>

1
docs/documentation/platform/sso/general-oidc.mdx → docs/documentation/platform/sso/general-oidc/overview.mdx
View File

@@ -1,5 +1,6 @@
---
title: "General OIDC"
sidebarTitle: "Overview"
description: "Learn how to configure OIDC for Infisical SSO with any OIDC-compliant identity provider"
---

8
docs/mint.json
View File

@@ -273,7 +273,13 @@
]
},
"documentation/platform/sso/auth0-oidc",
"documentation/platform/sso/general-oidc"
{
"group": "General OIDC",
"pages": [
"documentation/platform/sso/general-oidc/overview",
"documentation/platform/sso/general-oidc/group-membership-mapping"
]
}
]
},
{