SCIM overview

1. Sign in to Docker Hub.
2. Navigate to the SSO settings page for your organization or company.
   • Organization: Select Organizations, your organization, Settings, and then Security.
   • Company: Select Organizations, your company, and then Settings.
3. In the SSO connections table, select the Actions icon and Setup SCIM.
4. Copy the SCIM Base URL and API Token and paste the values into your IdP.

Early Access

The Docker Admin Console is an early access product.

It's available to all company owners and organization owners. You can still manage companies and organizations in Docker Hub, but the Admin Console includes enhanced features for company-level management.

1. Sign in to the Admin Console.
2. Select your organization or company in the left navigation drop-down menu, and then select SSO & SCIM.
3. In the SSO connections table, select the Actions icon and Setup SCIM.
4. Copy the SCIM Base URL and API Token and paste the values into your IdP.

Enable SCIM

1. Go to the Okta admin portal.
2. Go to the app you created when you configured your SSO connection.
3. On the app page, go to the General tab and select Edit App Settings.
4. Enable SCIM provisioning, then select Save.
5. Now you can access the Provisioning tab. Navigate to this tab, then select Edit SCIM Connection.
6. To configure SCIM in Okta, set up your connection like the following:
   • SCIM Base URL: SCIM connector base URL (copied from Docker Hub)
   • Unique identifier field for users: email
   • Supported provisioning actions: Push New Users and Push Profile Updates
   • Authentication Mode: HTTP Header
   • SCIM Bearer Token: HTTP Header Authorization Bearer Token (copied from Docker Hub)
7. Select Test Connector Configuration.
8. Review the test results.
9. Select Save.

Enable synchronization

1. Go to Provisioning > To App > Edit.
2. Enable Create Users, Update User Attributes, and Deactivate Users.
3. Select Save.
4. Remove unnecessary mappings. The necessary mappings are:
   • Username
   • Given name
   • Family name
   • Email

1. In the Azure admin portal, go to Enterprise Applications, then select the Docker application you created when you set up your SSO connection.
2. Go to Provisioning and select Get Started.
3. Select Automatic provisioning mode.
4. Enter the SCIM Base URL and API Token from Docker Hub into the Admin Credentials form.
5. Test the connection, then select Save.
6. Go to Mappings , then select Provision Azure Active Directory Groups.
7. Set the Enabled value to No.
8. Select Provision Azure Active Directory Users.
9. Remove all unsupported attributes.
10. Select Save.
11. Set the provisioning status to On.

Set up

1. Setup SSO and SCIM first.
2. In the Okta admin portal, go to Directory > Profile Editor and select User (Default).
3. Select Add Attribute and configure the values for the role, org, or team you want to add. Exact naming isn't required.
4. Return to the Profile Editor and select your application.
5. Select Add Attribute and enter the required values. The External Name and External Namespace must be exact. The external name values for org/team/role mapping are dockerOrg, dockerTeam, and dockerRole respectively, as listed in the previous table. The external namespace is the same for all of them: urn:ietf:params:scim:schemas:extension:docker:2.0:User.
6. After creating the attributes, go to the top and select Mappings > Okta User to YOUR APP.
7. Go to the newly created attributes and map the variable names selected above to the external names, then select Save Mappings. If you’re using JIT provisioning, continue to the following step.
8. Go to Applications > YOUR APP > General > SAML Settings > Edit > Step 2 and configure the mapping from the user attribute to the docker variables.

Assign roles by user

1. Go to Directory > People > YOUR USER > Profile, then select Edit on Attributes.
2. Update the attributes to the desired values.

Assign roles by group

1. Go to Directory > People > YOUR GROUP > Applications > YOUR APPLICATION, then select the Edit icon.
2. Update the attributes to the desired values.

If a user doesn't already have attributes set up, users who are added to the group will inherit these attributes upon provsioning.

Set up

1. Setup SSO and SCIM first.
2. In the Azure AD admin portal, go toEnterprise Apps > YOUR APP > Provisioning > Mappings > Provision Azure Active Directory Users.
3. To set up the new mapping, check Show advanced options, then select Edit attribute options.
4. Create new entries with the desired mapping for role, org, or group (for example, urn:ietf:params:scim:schemas:extension:docker:2.0:User:dockerRole) as a string type.
5. Go back to Attribute Mapping for users and click Add new mapping.

Expression mapping

This implementation works best for roles, but can't be used along with organization and team mapping using the same method. With this approach, you can assign attributes at a group level, which members can inherit. This is the recommended approach for role mapping.

1. In the Edit Attribute view, select the Expression mapping type.

2. If you can create app roles named as the role directly (for example, owner or editor), in the Expression field, you can use SingleAppRoleAssignment([appRoleAssignments]).

   Alternatively, if you’re restricted to using app roles you have already defined (for example, My Corp Administrators) you’ll need to setup a switch for these roles. For example:

   Switch(SingleAppRoleAssignment([appRoleAssignments]), "member", "My Corp Administrator", "owner", "My Corp Editor", "editor")`

3. Set the following fields:

   • Target attribute: urn:ietf:params:scim:schemas:extension:docker:2.0:User:dockerRole.
   • Match objects using this attribute: No
   • Apply this mapping: Always

4. Save your configuration.

Direct mapping

Direct mapping is an alternative to expression mapping. This implementation works for all three mapping types at the same time. In order to assign users, you'll need to use the Microsoft Graph API.

1. In the Edit Attribute view, select the Direct mapping type.

2. Set the following fields:

   • Source attribute: choose one of the allowed extension attributes in Entra (for example, extensionAttribute1)
   • Target attribute: urn:ietf:params:scim:schemas:extension:docker:2.0:User:dockerRole
   • Match objects using this attribute: No
   • Apply this mapping: Always

   If you're setting more than one attribute, for example role and organization, you need to choose a different extension attribute for each one.

3. Save your configuration.

Assign users

If you used expression mapping in the previous step, go to App registrations > YOUR APP > App Roles and create an app role for each Docker role. If possible, create it with a display name that is directly equivalent to the role in Docker, for example, owner instead of Owner. If set up this way, then you can use expression mapping to SingleAppRoleAssignment([appRoleAssignments]). Otherwise, a custom switch will have to be used. See Expression mapping.

To add a user:

1. Go to YOUR APP > Users and groups. Select Add user/group.
2. Select the user you want to add, then Select their desired role.

To add a group:

1. Go to YOUR APP > Users and groups. Select Add user/group.
2. Select the group you want to add, then Select the desired role for the users in that group.

If you used direct mapping in the previous step, go to Microsoft Graph Explorer and sign in to your tenant. You need to be a tenant admin to use this feature. Use the Microsoft Graph API to assign the extension attribute to the user with the value that corresponds to what the attribute was mapped to. See the Microsoft Graph API documentation on adding or updating data in extension attributes.

1. Sign in to Docker Hub.
2. Navigate to the SSO settings page for your organization or company.
   • Organization: Select Organizations, your organization, Settings, and then Security.
   • Company: Select Organizations, your company, and then Settings.
3. In the SSO connections table, select the Actions icon.
4. Select Disable SCIM.

Early Access

The Docker Admin Console is an early access product.

It's available to all company owners and organization owners. You can still manage companies and organizations in Docker Hub, but the Admin Console includes enhanced features for company-level management.

1. Sign in to the Admin Console.
2. Select your organization or company in the left navigation drop-down menu, and then select SSO & SCIM.
3. In the SSO connections table, select the Actions icon.
4. Select Disable SCIM.