Skip to content

Commit ec4647f

Browse files
OKTA SSO group mappings docs (#178)
* OKTA SSO group mappings docs * update screenshots plus some style and formatting fixes * couple of style fixes * fix lint errors in nav --------- Co-authored-by: Rosie Yohannan <[email protected]>
1 parent f087733 commit ec4647f

File tree

5 files changed

+60
-7
lines changed

5 files changed

+60
-7
lines changed
82.2 KB
Loading
174 KB
Loading

docs/guides/modules/ROOT/nav.adoc

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@
9191
** How-to guides
9292
*** xref:permissions-authentication:pull-an-image-from-aws-ecr-with-oidc.adoc[Pull an image from AWS ECR with OIDC]
9393
*** xref:execution-managed:run-a-job-in-a-container.adoc[Run a job in a container on your machine with Docker]
94-
*** xref:execution-managed:docker-compose.adoc[Installing and using docker-compose]
94+
*** xref:execution-managed:docker-compose.adoc[Installing and using Docker Compose]
9595
*** xref:execution-managed:high-uid-error.adoc[Debugging container ID cannot be mapped to host ID error]
9696
** Image support policies
9797
*** xref:execution-managed:android-images-support-policy.adoc[Android images support policy]
@@ -188,7 +188,7 @@
188188
*** xref:deploy:deploy-ios-applications.adoc[Deploy iOS applications]
189189
*** xref:deploy:deploy-over-ssh.adoc[Deploy over SSH]
190190
*** xref:deploy:publish-packages-to-packagecloud.adoc[Publish packages to Packagecloud]
191-
*** xref:deploy:deploy-to-npm-registry.adoc[Deploy to NPM registry]
191+
*** xref:deploy:deploy-to-npm-registry.adoc[Deploy to npm registry]
192192
193193
* Optimize
194194
** xref:optimize:optimizations.adoc[Optimizations reference]
@@ -225,6 +225,7 @@
225225
** SSO authentication
226226
*** xref:permissions-authentication:sso-overview.adoc[SSO overview]
227227
*** xref:permissions-authentication:set-up-sso.adoc[SSO setup]
228+
*** xref:permissions-authentication:sso-group-mapping.adoc[Set up SSO group mapping with Okta]
228229
*** xref:permissions-authentication:sign-in-to-an-sso-enabled-organization.adoc[Sign in to an SSO-enabled org]
229230
** Multi-factor authentication (MFA)
230231
*** xref:permissions-authentication:mfa.adoc[MFA overview]
@@ -288,7 +289,7 @@
288289
289290
* Developer toolkit
290291
** AI features
291-
*** xref:toolkit:using-the-circleci-mcp-server.adoc[Using the CircleCI MCP Server]
292+
*** xref:toolkit:using-the-circleci-mcp-server.adoc[Using the CircleCI MCP server]
292293
*** xref:toolkit:intelligent-summaries.adoc[Intelligent summaries]
293294
** CLI
294295
*** xref:toolkit:local-cli.adoc[Install and configure the CircleCI local CLI]
@@ -312,7 +313,7 @@
312313
* Plans and pricing
313314
** xref:plans-pricing:plan-overview.adoc[CircleCI plans overview]
314315
** xref:plans-pricing:credits.adoc[Credits overview]
315-
** xref:plans-pricing:plan-free.adoc[Free plan overview]
316-
** xref:plans-pricing:plan-performance.adoc[Performance plan overview]
317-
** xref:plans-pricing:plan-scale.adoc[Scale plan overview]
318-
** xref:plans-pricing:plan-server.adoc[Server plan overview]
316+
** xref:plans-pricing:plan-free.adoc[Free Plan overview]
317+
** xref:plans-pricing:plan-performance.adoc[Performance Plan overview]
318+
** xref:plans-pricing:plan-scale.adoc[Scale Plan overview]
319+
** xref:plans-pricing:plan-server.adoc[Server Plan overview]
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
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.

scripts/xref-mapping.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1528,5 +1528,10 @@
15281528
"component": "guides",
15291529
"module": "permissions-authentication",
15301530
"filename": "set-up-sso.adoc"
1531+
},
1532+
"sso-group-mapping": {
1533+
"component": "guides",
1534+
"module": "permissions-authentication",
1535+
"filename": "sso-group-mapping.adoc"
15311536
}
15321537
}

0 commit comments

Comments
 (0)