Co-authored-by: Hirsch Singhal <1666363+hpsin@users.noreply.github.com> Co-authored-by: Jovel Crisostomo <jovel@github.com> Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> Co-authored-by: Vanessa <vgrl@github.com>
8.3 KiB
title, shortTitle, intro, permissions, versions, redirect_from, type, topics, miniTocMaxHeadingLevel
| title | shortTitle | intro | permissions | versions | redirect_from | type | topics | miniTocMaxHeadingLevel | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Configuring authentication and provisioning for your enterprise using Okta | Configure with Okta | You can use Okta as an identity provider (IdP) to centrally manage authentication and user provisioning for {% data variables.product.prodname_ghe_managed %}. | Enterprise owners can configure authentication and provisioning for {% data variables.product.prodname_ghe_managed %}. |
|
|
how_to |
|
3 |
{% data reusables.saml.okta-ae-sso-beta %}
About SAML and SCIM with Okta
You can use Okta as an Identity Provider (IdP) for {% data variables.product.prodname_ghe_managed %}, which allows your Okta users to sign in to {% data variables.product.prodname_ghe_managed %} using their Okta credentials.
To use Okta as your IdP for {% data variables.product.prodname_ghe_managed %}, you can add the {% data variables.product.prodname_ghe_managed %} app to Okta, configure Okta as your IdP in {% data variables.product.prodname_ghe_managed %}, and provision access for your Okta users and groups.
The following provisioning features are available for all Okta users that you assign to your {% data variables.product.prodname_ghe_managed %} application.
| Feature | Description |
|---|---|
| Push New Users | When you create a new user in Okta, the user is added to {% data variables.product.prodname_ghe_managed %}. |
| Push User Deactivation | When you deactivate a user in Okta, it will suspend the user from your enterprise on {% data variables.product.prodname_ghe_managed %}. |
| Push Profile Updates | When you update a user's profile in Okta, it will update the metadata for the user's membership in your enterprise on {% data variables.product.prodname_ghe_managed %}. |
| Reactivate Users | When you reactivate a user in Okta, it will unsuspend the user in your enterprise on {% data variables.product.prodname_ghe_managed %}. |
Adding the {% data variables.product.prodname_ghe_managed %} application in Okta
{% data reusables.saml.okta-ae-applications-menu %}
- Click Browse App Catalog
- In the search field, type "GitHub AE", then click GitHub AE in the results.
- Click Add.
- For "Base URL", type the URL of your enterprise on {% data variables.product.prodname_ghe_managed %}.
- Click Done.
Enabling SAML SSO for {% data variables.product.prodname_ghe_managed %}
To enable single sign-on (SSO) for {% data variables.product.prodname_ghe_managed %}, you must configure {% data variables.product.prodname_ghe_managed %} to use the sign-on URL, issuer URL, and public certificate provided by Okta. You can find locate these details in the "GitHub AE" app.
{% data reusables.saml.okta-ae-applications-menu %} {% data reusables.saml.okta-ae-configure-app %}
- Click Sign On.
- Click View Setup Instructions.
- Take note of the "Sign on URL", "Issuer", and "Public certificate" details.
- Use the details to enable SAML SSO for your enterprise on {% data variables.product.prodname_ghe_managed %}. For more information, see "Configuring SAML single sign-on for your enterprise."
{% note %}
Note: To test your SAML configuration from {% data variables.product.prodname_ghe_managed %}, your Okta user account must be assigned to the {% data variables.product.prodname_ghe_managed %} app.
{% endnote %}
Enabling API integration
The "GitHub AE" app in Okta uses the {% data variables.product.product_name %} API to interact with your enterprise for SCIM and SSO. This procedure explains how to enable and test access to the API by configuring Okta with a {% data variables.product.pat_generic %} for {% data variables.product.prodname_ghe_managed %}.
-
In {% data variables.product.prodname_ghe_managed %}, generate a {% data variables.product.pat_v1 %} with the
admin:enterprisescope. For more information, see "Creating a {% data variables.product.pat_generic %}". {% data reusables.saml.okta-ae-applications-menu %} {% data reusables.saml.okta-ae-configure-app %} {% data reusables.saml.okta-ae-provisioning-tab %} -
Click Configure API Integration.
-
Select Enable API integration.
-
For "API Token", type the {% data variables.product.prodname_ghe_managed %} {% data variables.product.pat_generic %} you generated previously.
-
Click Test API Credentials.
{% note %}
Note: If you see Error authenticating: No results for users returned, confirm that you have enabled SSO for {% data variables.product.prodname_ghe_managed %}. For more information see "Enabling SAML SSO for {% data variables.product.prodname_ghe_managed %}."
{% endnote %}
Configuring SCIM provisioning settings
This procedure demonstrates how to configure the SCIM settings for Okta provisioning. These settings define which features will be used when automatically provisioning Okta user accounts to {% data variables.product.prodname_ghe_managed %}.
{% data reusables.saml.okta-ae-applications-menu %} {% data reusables.saml.okta-ae-configure-app %} {% data reusables.saml.okta-ae-provisioning-tab %}
- Under "Settings", click To App.
- To the right of "Provisioning to App", click Edit.
- To the right of "Create Users", select Enable.
- To the right of "Update User Attributes", select Enable.
- To the right of "Deactivate Users", select Enable.
- Click Save.
Allowing Okta users and groups to access {% data variables.product.prodname_ghe_managed %}
You can provision access to {% data variables.product.product_name %} for your individual Okta users, or for entire groups.
Provisioning access for Okta users
Before your Okta users can use their credentials to sign in to {% data variables.product.prodname_ghe_managed %}, you must assign the users to the "GitHub AE" app in Okta.
{% data reusables.saml.okta-ae-applications-menu %} {% data reusables.saml.okta-ae-configure-app %}
- Click Assignments.
- Select the Assign drop-down menu and click Assign to People.
- To the right of the required user account, click Assign.
- To the right of "Role", click a role for the user, then click Save and go back.
- Click Done.
Provisioning access for Okta groups
You can map your Okta group to a team in {% data variables.product.prodname_ghe_managed %}. Members of the Okta group will then automatically become members of the mapped {% data variables.product.prodname_ghe_managed %} team. For more information, see "Mapping Okta groups to teams."
Further reading
- Understanding SAML in the Okta documentation.
- Understanding SCIM in the Okta documentation.











