This tutorial describes the steps you need to perform in both CybSafe and Azure Active Directory (Azure AD) to configure automatic user provisioning.
When configured, Azure AD automatically provisions and de-provisions users and groups to CybSafe 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 CybSafe
Any deactivated users will be reactivated.
Remove users in CybSafe when they do not require access anymore
Keep user attributes synchronized between Azure AD and CybSafe
Provision groups and group memberships in CybSafe
Prerequisites
The scenario outlined in this tutorial assumes that you already have the following prerequisites:
A user account in Azure AD with permission to configure provisioning (for example, Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator).
A CybSafe Administrator account.
Setup
Step 1. Plan your provisioning deployment
Learn about how the provisioning service works.
Determine who will be in scope for provisioning.
Determine what data to map between Azure AD and CybSafe.
Step 2. Configure CybSafe to support provisioning with Azure AD
The Tenant URL for CybSafe is:
https://app.cybsafe.com/scim/v2/. This value will be entered in the Provisioning tab of your CybSafe application in the Azure portal.Login to CybSafe with your administrator account.
Navigate to Settings->Access Management.
Click Generate Token in the User Provisioning section. This value will be entered in the Provisioning tab of your CybSafe application in the Azure portal.
NB! this token can only be used with one CybSafe Azure App.
Step 3. Add CybSafe from the Azure AD application gallery
Add CybSafe from the Azure AD application gallery to start managing provisioning to CybSafe. If you have previously setup CybSafe for SSO, you can use the same application. However it is recommended that you create a separate app when testing out the integration initially. 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.
When assigning users and groups to CybSafe, you must select a role other than Default Access. Users with the Default Access role are excluded from provisioning and will be marked as not effectively entitled in the provisioning logs. If the only role available on the application is the default access role, you can update the application manifest to add additional roles.
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 CybSafe
This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and/or groups in TestApp based on user and/or group assignments in Azure AD.
To configure automatic user provisioning for CybSafe in Azure AD:
Sign in to the Azure portal. Select Enterprise Applications, then select All applications.
2. In the applications list, select CybSafe.
3. Select the Provisioning tab.
4. Set the Provisioning Mode to Automatic.
5. Under the Admin Credentials section, input your CybSafe Tenant URL and Secret Token. Click Test Connection to ensure Azure AD can connect to CybSafe. If the connection fails, ensure your CybSafe account has Admin permissions and try again.
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.
7. Select Save.
8. Under the Mappings section, select Synchronize Azure Active Directory Users to CybSafe.
9. Review the user attributes that are synchronized from Azure AD to CybSafe in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the user accounts in CybSafe for update operations. If you choose to change the matching target attribute, you will need to ensure that the CybSafe API supports filtering users based on that attribute. Select the Save button to commit any changes.
Supported SCIM attributes
Minimum for CybSafe user | Description |
|
userName | Required by SCIM, usually primary work email address |
|
emails[type eq "work"].value | Work email address marked as primary |
|
givenName | First name |
|
familyName | Last name |
|
addresses[type eq "work"].country | At least 1 address with only country subfield |
|
preferredLanguage | Language tag used for email communications |
|
| Option | Description |
| en_gb | English (U.K.) |
| en | International English |
| en-us | English (US) |
| nl | Dutch |
| ar | Arabic |
| es | Spanish (Latam) |
| es-ES | Spanish (Spain) |
| fr | French |
| de | German |
| it | Italian |
| pl | Polish |
| pt-BR | Potrugese (Brazil) |
| tr-TR | Turkish |
| ru | Russian |
| ja-JP | Japanese |
| zh-CN | Simplified Chinese |
| zh-HK | Traditional Chinese |
| ko-KR | Korean |
Optional but recommended |
|
|
active | Must be true (or user will be provisioned but archived) |
|
phoneNumbers[type eq "mobile"].value | Optional |
|
locale | Optional, default location for purposes of localizing |
|
department | Optional, for filtering in dashboards |
|
division | Optional, for filtering in dashboards |
|
organization | Optional, for filtering in dashboards |
|
title | optional, not used |
|
nickName | optional, used in CybSafe API as an alternative user identifying attribute |
|
timezone | not currently used |
|
Please note: Any other attributes from your SCIM will not sync across. Only the above attributes will be captured by CybSafe. If you have attribute mappings that you wish to be synced across to Group Management please ensure they are under Department, Division or Organization. If you do have additional attributes that you need synced across, consult the guide further on in the article on How to add additional attributes to the CybSafe Gallery App Schema.
Additional note: For Organisations where the userPrincipalName differs to the full email address please contact CybSafe customer support and confirm your preferred Azure property which contains the full email address.
If you have a mismatch between the full email address and userPrincipalName, users may experience issues with different email accounts or missed emails.
Custom attributes that can be optionally added (via add attribute process)
Attribute | Description | Values (if relevant) |
externalId | Captured, not currently used in reporting |
|
employeeType | used in CybSafe API for your external reporting |
|
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber | [Employee Number] used in CybSafe API for your external reporting |
|
city | Captured, not currently used in reporting |
|
office | Captured, not currently used in reporting |
|
businessUnit | Captured, not currently used in reporting |
|
grade | Captured, not currently used in reporting |
|
manager | Captured, not currently used in reporting |
|
10. Under the Mappings section, select Synchronize Azure Active Directory Groups to CybSafe.
11. Review the group attributes that are synchronized from Azure AD to CybSafe in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the groups in CybSafe for update operations. Select the Save button to commit any changes.
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 CybSafe, change the Provisioning Status to On in the Settings section.
14. Define the users and/or groups that you would like to provision to CybSafe by choosing the desired values in Scope in the Settings section.
15. When you are ready to provision, click Save.
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:
Use the provisioning logs to determine which users have been provisioned successfully or unsuccessfully
Check the progress bar to see the status of the provisioning cycle and how close it is to completion
If the provisioning configuration seems to be in an unhealthy state, the application will go into quarantine. Learn more about quarantine states here.
Go to The Identity & Access Management section in the CybSafe Platform, view the SCIM Token Section where you can observe the "Last SCIM Request" and "Last SCIM Change" date and time.
Note: You can assign someone via Azure who is already in the CybSafe platform, If the email addresses are identical we will sync the profiles.
If the email addresses do not match, a second identity will be created.
How to add additional attributes to the CybSafe Gallery app schema
Cybsafe's Azure gallery app may not support the adding of custom target attributes for some customers. You may need to add additional attributes for a variety purposes so it is necessary to follow the below steps to ensure you can add them.
Click the following link and login with your Microsoft administrator account: https://portal.azure.com/?Microsoft_AAD_Connect_Provisioning_forceSchemaEditorEnabled=true . This will force the ability for you to edit schemas in Azure.
Navigate to your Azure environment and the Enterprise applications page. Click on CybSafe. From here, select "Provisioning" on the left hand menu.
Click on "Edit provisioning".
Select Azure Active Directory Users.
Open the advanced options.
Click on Edit attribute list for CybSafe.
Enter in the target attribute from CybSafe. If you are unsure of what attribute to enter contact your customer success manager or support@cybsafe.com. Save it as a string, and click save.
Go back to the Attribute Mapping page. Click on Add New Mapping.
Select the target attribute you entered earlier. Then select what source attribute you would like to map it to. Then hit save.
You should see the new mapping in the attribute mapping page
Still have any questions?
If you have any questions or concerns, you can contact the team at support@cybsafe.com and we’ll be happy to answer them.