Support Home > Apps and Integrations > Integrate with Workplace by Facebook

Integrate with Workplace by Facebook

Use JumpCloud SAML Single Sign On (SSO) to give your users convenient but secure access to all their web applications with a single set of credentials. Automatically provision, update and deprovision users and groups in Workplace by Facebook from JumpCloud using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, user identity, and group management in JumpCloud for Workplace by Facebook. 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 Workplace by Facebook integration.

Prerequisites

  • A Workplace by Facebook user account with administrator permissions.
  • Your Workplace by Facebook domain, subdomain and company number.
  • A JumpCloud administrator account.

Important Considerations

  • Workplace by Facebook SCIM API is based on version 2.0 of the SCIM standard.
  • Tokens for Workplace for Facebook never expire. But, if you have to change your token, you must deactivate the IdM Integration, renew the token and then reactivate the integration.
  • Within Workplace, SCIM Groups are mapped to People Sets. Users should only be added to and removed from groups, never updated.
  • Delete operation will deactivate the user account.
  • Workplace by Facebook may truncate to 10000 members any group responses for performance reasons.
  • Groups are supported. 

Attribute Considerations

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

Group Management Important Considerations

Enabling Group Management

You must select the Enable management of User Groups and Group Membership in this application option to manage groups and group membership in the application from JumpCloud.

Group Provisioning and Syncing 

  • Empty groups are not created.
  • JumpCloud takes over management of existing groups in the application when the user group name in JumpCloud matches the name of the group in the application.
  • All user groups associated with the application in JumpCloud are synced. Syncing occurs whenever there is a membership or group change event.
  • Group renaming is supported.
  • If a user group is disassociated from the application in JumpCloud, syncing immediately stops and the group is left as-is in the application. All members of that user group are deactivated in the application unless they are associated with another active application group that is managed from JumpCloud.

Group Deletion

  • Managed groups deleted in JumpCloud are deleted in the application.
  • All members of the deleted group are deactivated in the application, unless they are associated with another active application group that is managed from JumpCloud.

Disabling Group Management

  • You can disable group and group membership management by unchecking the Enable management of User Groups and Group Membership in this application option.
  • The managed groups and group membership are left as-is in the application.
  • JumpCloud stops sending group membership information for the user, but the user’s identity will continue to be managed from JumpCloud.

Creating a new JumpCloud Application Integration

  1. Log in to the JumpCloud Admin Portal.
  2. Go 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. If this is a Bookmark application, enter its URL in the Bookmark URL field.
  8. Click Save Application.
  9. If successful, click:
    • Configure Application and go to the next section.
    • Close to configure your new connector at a later time.

Configuring the SSO Integration

To configure JumpCloud

  1. Create a new application or select it from the Configured Applications list.
  2. Select the SSO tab.
  3. Replace any instances of YOURDOMAIN, SUBDOMAIN, and COMPANY_NUMBER with your Workplace by Facebook values and add any desired attributes.
  4. Click save.

To download the certificate

  1. Find your application in the Configured Applications list and click anywhere in the row to reopen its configuration window.
  2. Select the SSO tab and click IDP Certificate Valid > Download certificate.

Tip:

The certificate.pem will download to your local Downloads folder.

To configure Workplace by Facebook

  1. Log in to Workplace by Facebook as an administrator.
  2. Navigate to Admin Panel > Security.
  3. Select Authentication SSO, then enable Single-sign on (SSO).
  4. Enter the following:
    • Name of the SSO Provider – Enter JumpCloud.
    • SAML URL – Copy and paste the JumpCloud IDP URL.
    • SAML Issuer URL – Copy and paste the IdP Entity ID.
    • SAML Certificate – Open the certificate downloaded in the previous section. Copy and paste its contents.
  5. Click Test SSO

Note:

Ensure the email address being used to authenticate with your IdP is the same as the Workplace account you are logged in.

  1. If successful, click Save Changes

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: 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 authentication workflow(s)

IdP Initiated

  • Access the JumpCloud User Console.
  • Select the Service Provider icon.
  • This should automatically launch and login to the application.

SP Initiated

  • Navigate to your Service Provider application URL.
  • You will be redirected to log in to the JumpCloud User Portal.
  • The browser will be redirected back to the application and be automatically logged in.

Configuring the Identity Management Integration

To configure Workplace by Facebook

  1. Sign into Workplace by Facebook with your administrator account.
  2. In the Admin Panel, open the Integrations tab.
  3. Click on the Create App button.
  4. Enter JumpCloud and a description.
  5. Add a profile picture for the app. This will be used any time the app is visually represented, for instance if it makes a post to group.
  6. Choose the required permissions for the app, based on the integration functionality you require.
  7. Copy and safely store the access token that’s shown to you. You’ll need this when making API calls.

Warning: The secret (token) may only be shown once. Copy it to a secure location, like the JumpCloud Password Manager, for future reference.

To configure JumpCloud

  1. Create a new application or select it from the Configured Applications list.
  2. Select the Identity Management tab.
  3. Select the Enable management of User Groups and Group Membership in this application checkbox if you want to provision, manage, and sync groups in Workplace by Facebook from JumpCloud. 
  4. Click Configure.
  5. You’re presented with a Token Key field. Paste the access token you generated in the previous section.
  6. Click Activate. 
  7. You will receive a confirmation that the Identity Management integration has been successfully verified.
  8. Click save.
  9. You can now connect user groups to the application in JumpCloud to provision the members of that group in Workplace by Facebook.

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. 

Workplace by Facebook User Attributes

JumpCloud Property JumpCloud UI Field Name SCIM v2 Mapping Workplace by Facebook Value
username Username userName userName
email Company Email emails:value emails
active Status active -
firstname First Name name.givenName firstName
lastname Last Name name.familyName lastName
firstname/lastname First Name/Last Name name.formatted Display Name
employeeType employeeType userType userType
addresses.streetAddress Work Street Address addresses.streetAddress addresses.streetAddress
addresses.locality Work City addresses.locality addresses.locality
addresses.region Work State addresses.region addresses.region
addresses.postalCode Work Postal Code addresses.postalCode addresses.postalCode
addresses.country Work Country addresses.country addresses.country
phoneNumbers.value Work Phone phoneNumbers.value phoneNumbers.value
employeeIdentifier Employee ID externalID externalID
department Department department Department
costcenter CostCenter costcenter Cost Center
location Location locale Location
jobTitle Job Title title Position
preferredLanguage preferredLanguage preferredLanguage preferredLanguage
locale Locale locale Language
company Company organization Organization

Group Attributes

JumpCloud Property JumpCloud UI Field Name SCIM v2 Mapping Application Value
name Name displayName Organization

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 – The 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.

Removing the Integration

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

  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 tab.
  5. Scroll to the bottom of the configuration.
  6. Click Deactivate SSO. 
  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 and click to open its details panel.
  4. Check the box for the application.
  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.

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