Help Center Home > Apps and Integrations > Integrate with Apple Business Manager

Integrate with Apple Business Manager

Managed Apple Accounts are the gateway to Bring Your Own Device (BYOD) Programs. These accounts, created within Apple Business Manager (ABM), or using JumpCloud’s SSO and SCIM Connector, are required for managing user-owned devices with JumpCloud.

Use JumpCloud OIDC Single Sign On (SSO) to give your users convenient but secure access to their Managed Apple Account with a single set of credentials. Automatically provision, update and deprovision users in ABM from JumpCloud, centralizing user lifecycle and user identity management in JumpCloud for ABM. Save time and avoid mistakes, as well as potential security risks, related to manually creating users.

Read this article to learn how to setup the ABM integration.

Prerequisites

  • A JumpCloud administrator account
  • JumpCloud SSO Package or higher or SSO à la carte option
  • An ABM account with the role of Administrator or People Manager
  • An Apple verified domain and federated authentication
    • If federated authentication is not already enabled, setting up SSO will automatically enable it
  • SCIM must be enabled in the ABM Directory Sync settings

Important Considerations

  • A user’s email address must belong to an Apple verified domain for them to be created and updated through SCIM
  • All newly provisioned users will have the default role of staff
  • It is recommended to set your token expiration to 12 months.

Important:

You may not receive an alert when your token is about to expire. Set a reminder in your calendar to refresh your token before the expiration date.

  • If you need to update your token, you must deactivate the IdM integration, update the token, and then reactivate the IdM integration
  • Password synchronization is not supported

Attribute Considerations

  • A default set of attributes are managed for users. See the Attribute Mappings section for more details
  • The following attribute is not supported by JumpCloud:
    • division

Creating a new JumpCloud Application Integration

  1. Log in to the JumpCloud Admin Portal.
  2. Navigate to USER AUTHENTICATION > SSO Applications.
  3. Click + Add New Application.
  4. Type the name of the application in the Search field and select it.
  5. Click Next.
  6. In the Display Label, type your name for the application. Optionally, you can enter a Description, adjust the User Portal Image and choose to hide or Show in User Portal.
  7. Click Save Application.
  8. Click Configure Application.

Configuring the SSO Integration

To configure JumpCloud

  1. On the SSO tab of the ABM connector, click Activate.
  2. Copy the Client ID and Secret.

Warning:

The Client ID and Secret (token) may only be shown once. Copy them to a secure location, like the JumpCloud Password Manager, for future reference.

  1. Click Got It.

To configure Apple

Important:

Federating a Domain that already has Managed Apple Accounts takes up to 30 days. For more information, please consult Apple's Documentation.

  1. Log into Apple.
  2. Go to My Profile > Managed Apple Accounts
  3. Under Domains, click Manage
  4. Select Custom Identity Provider and enter the following information:
    • Name - <name of your connector>
    • Client ID - copy and paste the Client ID generated in the previous section
    • Client Secret - copy and paste the Client Secret generated in the previous section
    • SSF Config URL - https://ssf.jumpcloud.com/.well-known/ssf-configuration
    • OpenID Config URL - https://oauth.id.jumpcloud.com/.well-known/openid-configuration
  5. Click Continue
  6. Click Sign in with <name of your connector>
  7. When signed in, click Continue.
  8. Under User sign in, ensure it shows Connected.

Authorizing User SSO Access

Users are implicitly denied access to applications. After you connect an application to JumpCloud, you need to authorize user access to that application. You can authorize user access from the Application Configuration panel or from the Groups Configuration panel. 

To authorize user access from the Application Configuration panel

  1. Log in to the JumpCloud Admin Portal.
  2. Go to USER AUTHENTICATION > SSO Applications, then select the application to which you want to authorize user access.
  3. Select the User Groups tab. If you need to create a new group of users, see Get Started: User Groups.
  4. Select the check box next to the group of users you want to give access.
  5. Click save. 

To learn how to authorize user access from the Groups Configuration panel, see Authorize Users to an SSO Application.

Validating SSO user authentication workflow(s)

IdP-initiated user workflow

  • Access the JumpCloud User Console
  • Go to Applications and click an application tile to launch it
  • JumpCloud asserts the user's identity to the SP and is authenticated without the user having to log in to the application

SP-initiated user workflow

  • Go to the SP application login - generally, there is either a special link or an adaptive username field that detects the user is authenticated through SSO

Note:

This varies by SP.

  • Login redirects the user to JumpCloud where the user enters their JumpCloud credentials
  • After the user is logged in successfully, they are redirected back to the SP and automatically logged in

Configuring the Identity Management Integration

To configure Apple

  1. In ABM, navigate to Directory Sync > Custom Sync and click Enable.
  2. In Authorization callback URL - enter https://console.jumpcloud.com/api/v2/provision/applebusinessmanager/callback.
  3. Click the + Client Secret link and select 12 months (recommended).
  4. Click Save.
  5. Copy the Client ID and Client Secret.

Warning:

The Client ID and Secret (token) may only be shown once. Copy them to a secure location, like the JumpCloud Password Manager, for future reference.

Important:

You may not receive an alert when your secret is about to expire. Set a reminder in your calendar to refresh your secret before the expiration date.

  1. Click Done.

To configure JumpCloud

  1. Create a new application or select it from the Configured Applications list.
  2. Select the Identity Management tab.
  3. Click Configure.
  4. You're presented with two fields:
    • Client ID - enter the Client ID generated in the previous section
    • Client Secret - enter the Client Secret generated in the previous section
  5. Click Activate.
  6. If the status of the sync in Apple is green, the sync has been successfully set up.
  7. You can now connect user groups to the application in JumpCloud to provision the members of that group in ABM. Learn how to Authorize Users to an Application.

Attribute Mappings

The following table lists attributes that JumpCloud sends to the application. See Attribute Considerations for more information regarding attribute mapping considerations. 

Learn about JumpCloud Properties and how they work with system users in our API. 

ABM User Attributes

JumpCloud Property JumpCloud UI SCIM v2 Mapping ABM Value
firstname First Name name.givenName First name
lastname Last Name name.familyName Last name
email Company Email emails [work] email address
department Department department Department
employeeIdentifier Employee ID externalId Person Number
costcenter CostCenter costcenter Cost center

Importing Users

This functionality is helpful if users have already been created in the application but have not been created in JumpCloud.

  1. Log in to the JumpCloud Admin Portal.
  2. Go to USER AUTHENTICATION > SSO Applications.
  3. Search for the application and click to open its configuration panel. 
  4. Select the Identity Management tab.
  5. Click manual import.
  6. Select the users you want to create in JumpCloud from the application from the list of users that appear. Users in the list have two import statuses:
    • New - user has not been imported.
    • Imported - user has been imported and has an account in JumpCloud.

Tip: Try using the New Users-only filter when selecting users to import. This will move all of your new users to the top of the list, making them easier to identify and select.

  1. Click import.
    • If you are importing less than 100 users, your import results will display in real time and you can continue onboarding your users. 
    • If you have more than 100 users being imported, JumpCloud will send you an email when your import is complete.
  1. You can now connect and grant users access to all their JumpCloud resources. Learn more in the Authorize Users to an Application and Connecting Users to Resources articles.

Warning: Imported users must be members of a user group bound to an application for JumpCloud to manage their identity in, and access to, the application.

SCIM Directory Insights Events

The following Directory Insights (DI) events provide visibility into failures and detailed information about the user and group data being added or updated from HR or other external solutions to JumpCloud.

Note:

Customers with no package or the Device Management Package will need to add the Directory Insights à la carte option. Directory Insights is included in all other packages.

SCIM DI Integration Events

Event Name Event Description
idm_integration_activate Logged when an IT admin attempts to activated new SCIM Identity Management integration.
idm_integration_update Logged when an IT admin attempts to update a configured and activated SCIM Identity Management integration.
idm_integration_reauth Logged when an IT admin attempts to change the credentials for an activated SCIM Identity Management integration.
idm_integration_delete Logged when an IT admin attempts to deactivate an activated SCIM Identity Management integration.

SCIM DI User Events

Event Name Event Description
user_create_provision Logged when JumpCloud tries to create a new user in service provider application.
user_update_provision Logged when JumpCloud tries to update an existing user in service provider application.
user_deprovision Logged when JumpCloud tries to change an existing user to inactive in the service provider application.
user_delete_provision Logged when JumpCloud tries to delete an existing user in service provider application.
user_lookup_provision Logged when JumpCloud encounters an issue when trying to lookup a user to determine if the user needs to be created or updated.

Removing the Integration

Important:

These are steps for removing the integration in JumpCloud. Consult Apple’s documentation for any additional steps needed to remove the integration in ABM. Failure to remove the integration successfully for both Apple and JumpCloud may result in users losing access to the application.

To deactivate the IdM Integration

  1. Log in to the JumpCloud Admin Portal.
  2. Go to USER AUTHENTICATION > SSO Applications.
  3. Search for the application that you’d like to deactivate and click to open its details panel. 
  4. Under the company name and logo on the left hand panel, click the Deactivate IdM connection link.
  5. Click confirm. 
  6. If successful, you will receive a confirmation message.

To deactivate the SSO Integration or Bookmark

  1. Log in to the JumpCloud Admin Portal.
  2. Go to USER AUTHENTICATION > SSO Applications.
  3. Search for the application that you’d like to deactivate and click to open its details panel. 
  4. Select the SSO or Bookmark tab.
  5. Scroll to the bottom of the configuration.
  6. Click Deactivate SSO or Deactivate Bookmark. 
  7. Click save. 
  8. If successful, you will receive a confirmation message.

To delete the application

  1. Log in to the JumpCloud Admin Portal.
  2. Go to USER AUTHENTICATION > SSO Applications.
  3. Search for the application that you’d like to delete.
  4. Check the box next to the application to select it.
  5. Click Delete.
  6. Enter the number of the applications you are deleting
  7. Click Delete Application.
  8. If successful, you will see an application deletion confirmation notification.
Back to Top

List IconIn this Article

Still Have Questions?

If you cannot find an answer to your question in our FAQ, you can always contact us.

Submit a Case