Configuring SCIM provisioning for Enterprise Managed Users with Okta

You can provision new users and manage their membership of your enterprise and teams using Okta as your identity provider.

To manage users in your enterprise with your identity provider, your enterprise must be enabled for Enterprise Managed Users, which are available with GitHub Enterprise Cloud. For more information, see "About Enterprise Managed Users."

About provisioning with Okta

You can use Enterprise Managed Users with Okta as your identity provider to provision new accounts, manage enterprise membership, and manage team memberships for organizations in your enterprise. For more information about provisioning for Enterprise Managed Users, see "Configuring SCIM provisioning for enterprise managed users."

Before you can configure provisioning with Okta, you must configure SAML single-sign on. For more information, see "Configuring SAML single sign-on for Enterprise Managed Users."

To configure provisioning with Okta, you must set your enterprise's name in the GitHub Enterprise Managed User application and enter your setup user's personal access token. You can then start provisioning users in Okta.

Supported features

Enterprise Managed Users supports many provisioning features in Okta.

FeatureDescription
Push New UsersUsers that are assigned to the GitHub Enterprise Managed User application in Okta are automatically created in the enterprise on GitHub.
Push Profile UpdateUpdates made to the user's profile in Okta will be pushed to GitHub.
Push GroupsGroups in Okta that are assigned to the GitHub Enterprise Managed User application as Push Groups are automatically created in the enterprise on GitHub.
Push User DeactivationUnassigning the user from the GitHub Enterprise Managed User application in Okta will disable the user on GitHub. The user will not be able to sign in, but the user's information is maintained.
Reactivate UsersUsers in Okta whose Okta accounts are reactivated and who are assigned back to the GitHub Enterprise Managed User application will be enabled.

Note: Enterprise Managed Users does not support modifications to usernames.

Setting your enterprise name

After your enterprise with managed users has been created, you can begin to configure provisioning by setting your enterprise name in Okta.

  1. Navigate to your GitHub Enterprise Managed User application on Okta.
  2. Click the Sign On tab.
  3. To make changes, click Edit.
  4. Under "Advanced Sign-on Settings", in the "Enterprise Name" text box, type your enterprise name. For example, if you access your enterprise at https://github.com/enterprises/octoinc, your enterprise name would be "octoinc". Screenshot of the Enterprise Name field on Okta
  5. To save your enterprise name, click Save.

Configuring provisioning

After setting your enterprise name, you can proceed to configure provisioning settings.

To configure provisioning, the setup user with the @SHORT-CODE_admin username will need to provide a personal access token with the admin:enterprise scope. For more information on creating a new token, see "Creating a personal access token."

  1. Navigate to your GitHub Enterprise Managed User application on Okta.
  2. Click the Provisioning tab.
  3. In the settings menu, click Integration.
  4. To make changes, click Edit.
  5. Select Enable API integration.
  6. In the "API Token" field, enter the personal access token with the admin:enterprise scope belonging to the setup user. Screenshot showing the API Token field on Okta
  7. Click Test API Credentials. If the test is successful, a verification message will appear at the top of the screen.
  8. To save the token, click Save.
  9. In the settings menu, click To App. Screenshot showing the To App menu item on Okta
  10. To the right of "Provisioning to App", to allow changes to be made, click Edit.
  11. Select Enable for Create Users, Update User Attributes, and Deactivate Users. Screenshot showing provisioning options on Okta
  12. To finish configuring provisioning, click Save.

Assigning users

After you have configured SAML SSO and provisioning, you will be able provision new users on GitHub.com by assigning users to the GitHub Enterprise Managed User application. You can also automatically manage organization membership by assigning groups to the application as push groups and connecting the push groups to teams in your organizations. For more information about managing teams, see "Managing team memberships with identity provider groups."

When assigning users, you can use the "Roles" attribute in the GitHub Enterprise Managed User application to set a user's role in your enterprise on GitHub. For more information on roles, see "Roles in an enterprise."

Screenshot showing the role options for provisioned user on Okta

Did this doc help you?Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.