Tutorial: Configure Global Relay Identity Sync for automatic user provisioning

This tutorial describes the steps you need to perform in both Global Relay Identity Sync and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and de-provisions users and groups to Global Relay Identity Sync using the Azure AD Provisioning service. For important details on what this service does, how it works, and frequently asked questions, see Automate user provisioning and deprovisioning to SaaS applications with Azure Active Directory.

Capabilities supported

  • Create users in Global Relay Identity Sync
  • Remove users in Global Relay Identity Sync when they do not require access anymore
  • Keep user attributes synchronized between Azure AD and Global Relay Identity Sync
  • Provision groups and group memberships in Global Relay Identity Sync

Note

Global Relay Identity Sync provisioning connector utilizes a SCIM authorization method that is no longer supported due to security concerns. Efforts are underway with Global Relay to switch to a more secure authorization method.

Prerequisites

The scenario outlined in this tutorial assumes that you already have the following prerequisites:

  • An Azure AD tenant
  • A user account in Azure AD with permission to configure provisioning (for example, Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator).

Step 1. Plan your provisioning deployment

  1. Learn about how the provisioning service works.
  2. Determine who will be in scope for provisioning.
  3. Determine what data to map between Azure AD and Global Relay Identity Sync.

Step 2. Configure Global Relay Identity Sync to support provisioning with Azure AD

Contact your Global Relay Identity Sync representative to receive the Tenant url. This value will be entered in the Tenant URL field in the Provisioning tab of your Global Relay Identity Sync application in the Azure portal.

Add Global Relay Identity Sync from the Azure AD application gallery to start managing provisioning to Global Relay Identity Sync. Learn more about adding an application from the gallery here.

Step 4. Define who will be in scope for provisioning

The Azure AD provisioning service allows you to scope who will be provisioned based on assignment to the application and or based on attributes of the user / group. If you choose to scope who will be provisioned to your app based on assignment, you can use the following steps to assign users and groups to the application. If you choose to scope who will be provisioned based solely on attributes of the user or group, you can use a scoping filter as described here.

  • Start small. Test with a small set of users and groups before rolling out to everyone. When scope for provisioning is set to assigned users and groups, you can control this by assigning one or two users or groups to the app. When scope is set to all users and groups, you can specify an attribute based scoping filter.

Step 5. Configure automatic user provisioning to Global Relay Identity Sync

This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and/or groups in Global Relay Identity Sync app based on user and/or group assignments in Azure AD.

To configure automatic user provisioning for Global Relay Identity Sync in Azure AD:

  1. Sign in to the Azure portal. Select Enterprise Applications, then select All applications.

    Enterprise applications blade

  2. In the applications list, select Global Relay Identity Sync.

    The Global Relay Identity Sync link in the Applications list

  3. Select the Provisioning tab.

    Provisioning tab

  4. Set the Provisioning Mode to Automatic.

    Provisioning tab automatic

  5. Under the Admin Credentials section, input your Global Relay Identity Sync Tenant url. Click Test Connection to ensure Azure AD can connect to Global Relay Identity Sync. If the connection fails, ensure your Global Relay Identity Sync account has Admin permissions and contact your Global Relay representative to resolve the issue.

    Authorization button

  6. In the Notification Email field, enter the email address of a person or group who should receive the provisioning error notifications and select the Send an email notification when a failure occurs check box.

    Notification Email

  7. Select Save.

  8. Under the Mappings section, select Synchronize Azure Active Directory Users to Global Relay Identity Sync.

  9. Review the user attributes that are synchronized from Azure AD to Global Relay Identity Sync in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the user accounts in Global Relay Identity Sync for update operations. If you choose to change the matching target attribute, you will need to ensure that the Global Relay Identity Sync API supports filtering users based on that attribute. Select the Save button to commit any changes.

    Attribute Type
    userName String
    active Boolean
    displayName String
    title String
    preferredLanguage String
    name.givenName String
    name.familyName String
    name.formatted String
    addresses[type eq "work"].formatted String
    addresses[type eq "work"].streetAddress String
    emails[type eq "work"].value String
    addresses[type eq "work"].locality String
    addresses[type eq "work"].region String
    addresses[type eq "work"].postalCode String
    addresses[type eq "work"].country String
    addresses[type eq "other"].formatted String
    phoneNumbers[type eq "work"].value String
    phoneNumbers[type eq "mobile"].value String
    phoneNumbers[type eq "fax"].value String
    externalId String
    name.honorificPrefix String
    name.honorificSuffix String
    nickName String
    userType String
    locale String
    timezone String
    emails[type eq "home"].value String
    emails[type eq "other"].value String
    phoneNumbers[type eq "home"].value String
    phoneNumbers[type eq "other"].value String
    phoneNumbers[type eq "pager"].value String
    addresses[type eq "home"].streetAddress String
    addresses[type eq "home"].locality String
    addresses[type eq "home"].region String
    addresses[type eq "home"].postalCode String
    addresses[type eq "home"].country String
    addresses[type eq "home"].formatted String
    addresses[type eq "other"].streetAddress String
    addresses[type eq "other"].locality String
    addresses[type eq "other"].region String
    addresses[type eq "other"].postalCode String
    addresses[type eq "other"].country String
    roles[primary eq "True"].display String
    roles[primary eq "True"].type String
    roles[primary eq "True"].value String
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber String
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:costCenter String
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:organization String
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division String
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department String
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager Reference
    urn:ietf:params:scim:schemas:extension:GlobalRelay:2.0:User:proxyAddresses String
    urn:ietf:params:scim:schemas:extension:GlobalRelay:2.0:User:extensionAttribute1 String
    urn:ietf:params:scim:schemas:extension:GlobalRelay:2.0:User:extensionAttribute2 String
    urn:ietf:params:scim:schemas:extension:GlobalRelay:2.0:User:extensionAttribute3 String
    urn:ietf:params:scim:schemas:extension:GlobalRelay:2.0:User:extensionAttribute4 String
    urn:ietf:params:scim:schemas:extension:GlobalRelay:2.0:User:extensionAttribute5 String
    urn:ietf:params:scim:schemas:extension:GlobalRelay:2.0:User:extensionAttribute6 String
    urn:ietf:params:scim:schemas:extension:GlobalRelay:2.0:User:extensionAttribute7 String
    urn:ietf:params:scim:schemas:extension:GlobalRelay:2.0:User:extensionAttribute8 String
    urn:ietf:params:scim:schemas:extension:GlobalRelay:2.0:User:extensionAttribute9 String
    urn:ietf:params:scim:schemas:extension:GlobalRelay:2.0:User:extensionAttribute10 String
    urn:ietf:params:scim:schemas:extension:GlobalRelay:2.0:User:extensionAttribute11 String
    urn:ietf:params:scim:schemas:extension:GlobalRelay:2.0:User:extensionAttribute12 String
    urn:ietf:params:scim:schemas:extension:GlobalRelay:2.0:User:extensionAttribute13 String
    urn:ietf:params:scim:schemas:extension:GlobalRelay:2.0:User:extensionAttribute14 String
    urn:ietf:params:scim:schemas:extension:GlobalRelay:2.0:User:extensionAttribute15 String
  10. Under the Mappings section, select Synchronize Azure Active Directory Groups to Global Relay Identity Sync.

  11. Review the group attributes that are synchronized from Azure AD to Global Relay Identity Sync in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the groups in Global Relay Identity Sync for update operations. Select the Save button to commit any changes.

    Attribute Type
    displayName String
    members Reference
  12. To configure scoping filters, refer to the following instructions provided in the Scoping filter tutorial.

  13. To enable the Azure AD provisioning service for Global Relay Identity Sync, change the Provisioning Status to On in the Settings section.

    Provisioning Status Toggled On

  14. Define the users and/or groups that you would like to provision to Global Relay Identity Sync by choosing the desired values in Scope in the Settings section.

    Provisioning Scope

  15. When you are ready to provision, click Save.

    Saving Provisioning Configuration

This operation starts the initial synchronization cycle of all users and groups defined in Scope in the Settings section. The initial cycle takes longer to perform than subsequent cycles, which occur approximately every 40 minutes as long as the Azure AD provisioning service is running.

Step 6. Monitor your deployment

Once you've configured provisioning, use the following resources to monitor your deployment:

  1. Use the provisioning logs to determine which users have been provisioned successfully or unsuccessfully
  2. Check the progress bar to see the status of the provisioning cycle and how close it is to completion
  3. If the provisioning configuration seems to be in an unhealthy state, the application will go into quarantine. Learn more about quarantine states here.

Additional resources

Next steps