|
| 1 | += Set up SSO group mapping with Okta |
| 2 | +:page-platform: Cloud |
| 3 | +:page-description: Follow this guide to set up SSO (Single sign-on) group mapping with Okta and CircleCI. |
| 4 | +:experimental: |
| 5 | + |
| 6 | +SSO Group Mapping automatically assigns users from your identity provider (IdP) to groups in CircleCI. Group assignments are updated in real-time when users authenticate through SSO. |
| 7 | +This feature enables you to manage both groups and their members directly within your identity provider, streamlining user administration across your organization. |
| 8 | + |
| 9 | +NOTE: Once SSO Group Mapping is configured, your IdP will have complete control over group management. Any group assignments created manually within CircleCI will be overwritten when users authenticate via SSO. All group management must be performed through your identity provider. |
| 10 | + |
| 11 | +== Prerequisites |
| 12 | + |
| 13 | +Before you begin, ensure you have the following: |
| 14 | + |
| 15 | +* You are using Okta as your IdP and have access to your Okta admin console. |
| 16 | +* SSO is configured in your CircleCI organization and you have the organization admin role in CircleCI. For information on roles and permissions, see the xref:roles-and-permissions-overview.adoc[Roles and permissions overview]. |
| 17 | +* Your CircleCI organization has one or more groups. For more information on groups, see xref:manage-groups.adoc[Manage groups]. |
| 18 | + |
| 19 | +== How to set up group mapping with Okta |
| 20 | + |
| 21 | +=== 1. Configure Okta |
| 22 | + |
| 23 | +First, you will need to configure your Okta settings. Follow the steps below, or refer to link:https://help.okta.com/oie/en-us/content/topics/apps/define-group-attribute-statements.htm[Okta's group attribute statements documentation] for more detailed information. |
| 24 | + |
| 25 | +. Open your Okta admin console and navigate to Applications. |
| 26 | +. Select your CircleCI application. |
| 27 | +. Navigate to the Sign On tab and scroll down to SAML Attributes. |
| 28 | +. Add a group attribute statement with the name 'groups'. |
| 29 | +. Use the filter to limit which groups will sync to CircleCI. Use the regex value `.*` to capture all groups. |
| 30 | + |
| 31 | +.Okta SSO group attribute settings |
| 32 | +image::guides:ROOT:authentication/sso-group-mapping-okta-setup.png[Screenshot of the Okta SSO group attribute settings] |
| 33 | + |
| 34 | +=== 2. Configure CircleCI |
| 35 | + |
| 36 | +. In the link:https://app.circleci.com/home/[CircleCI web app], select your organization. |
| 37 | +. Select **Organization Settings** in the sidebar. |
| 38 | +. Select **Single sign-on (SSO)** from the sidebar. |
| 39 | +. Go to the Group Mappings section and click btn:[Add mapping]. This will open a form in a dropdown. |
| 40 | +. Enter the name of your Okta group under "SAML group name" and select the corresponding CircleCI group you want to map it to. |
| 41 | +. Select btn:[Add mapping] in the form to save your configuration. |
| 42 | + |
| 43 | +.Okta SSO group attribute settings in CircleCI |
| 44 | +image::guides:ROOT:authentication/sso-group-mapping-open.png[Screenshot of the Okta SSO group attribute settings] |
| 45 | + |
| 46 | + |
| 47 | +Once you have completed these steps, user assignments for any groups you have added to group mappings will be automatically updated when users authenticate via SSO into CircleCI. |
0 commit comments