Below is a list of Cymmetri connectors along with brief descriptions:

Azure provisioning in Cymmetri involves setting up configurations to automate the creation and management of user accounts in Microsoft Entra ID. This allows for seamless user onboarding and offboarding processes.

To implement Azure provisioning in Cymmetri, follow these general steps:

The administrator needs to login to Azure Portal: https://portal.azure.com

Once logged in click on More services-> button

In the next screen click on Identity -> App registrations inside the Identity management section

Next click on New registration to register a new App. Registering your application establishes a trust relationship between your app and the Microsoft identity platform. The trust is unidirectional: your app trusts the Microsoft identity platform, and not the other way around. Once created, the application object cannot be moved between different tenants.

Next enter the Application Name and select the Supported account types to organizational directory only : Accounts in this organizational directory only (Cymmetri Organization only - Single tenant) and then click on Register

Once registered next click on Authentication menu and +Add a platform.

On the next screen select Mobile and desktop applications

Enter a Custom redirect URIs: http://localhost and click on Configure

Further enable the Public Client flows and click on Save button

Next go to Certificates and secrets menu and create a new client secret:

Next enter a Description for the and select the duration after which the secret would Expire -Recommended is 180 days (6 months) but can be changed as per the need. Once both the details are entered click on Add button

Next copy and save the Client Secret ID and Client Secret Value in a safe and accessible place. Client secret values cannot be viewed, except for immediately after creation. Be sure to save the secret when created before leaving the page.

Once the client secret details are stored next click on API permissions menu and then + Add a permission

On this page select Microsoft Graph

On the next page we require permissions for both Delegated and Application permissions. Select each type of permission and in that Search and select the following permissions/scopes:

1. APIConnectors.Read.All

2. Directory.ReadWrite.All

3. OpenID (Not available for Application Permissions)

4. PrivilegedAccess.Read.AzureAD

5. User.ReadWrite.All

6. Directory.Read.All

Once all the permissions are added a warning is shown: "You are editing permission(s) to your application, users will have to consent even if they’ve already done so previously." The administrator needs to click on the "Grant admin consent for Cymmetri Organization" link

On the click of the link a popup appears to grant admin consent, click on Yes

Next click on Expose an API and then click on Add to add an Application ID URI: The Application ID URI, also called identifier URI, is a globally unique URI used to identify the web API. This URI is the prefix for scopes in the Oauth protocol. You can either use the default value in the form of api://, or specify a more readable URI.

On the next page keep the default values intact and click on Save button

Finally you can see the Overview page that contains all the information you need to configure Azure in Cymmetri.

Also the User config Application Authority can be obtained from the endpoint section in the Overview page:

This completes the Azure side of the configuration, next the administrator needs to need to move to Cymmetri and configure the Azure application. Mentioned below are the steps required to configure Azure in Cymmetri:

Add a new Azure application Identity Hub->Applications and then click on the +Add New button

Once added the administrator needs to go to Policy Attribute section and ensure all the below mentioned attributes are present (Add if not already present):

• mailNickname

• displayName

• __PASSWORD__

• __NAME__

• userPrincipalName

• givenName

• surname

• mail

• usageLocation

Next the administrator needs to go to the Policy Map section and ensure a mapping shown as below is created:

Once the policy map is created next the administrator needs to go to Provisioning section and then to Server Configuration and need to configure the connector server as shown below:

Once the Server Configuration is done next the administrator needs to implement User Configuration with the below mentioned fields:

• User config Application Authority: This is the authority under which the application operates. For example, if you're using Azure AD, the application authority might be https://login.microsoftonline.com/<tenant_id>/oauth2/authorize

• User config application client id: This is the unique identifier for your application. It is provided by Azure when you register your application. For example, e9a5a8b6-8af7-4719-9821-0deef255f68e.

• Client Secret: This is a secret key used by the application to prove its identity when requesting access tokens. It should be kept confidential. For example, 7f7df45a-251e-49d3-a396-748bf8e05a3c.

• User config domain: This is the domain associated with your Azure AD. For example, contoso.onmicrosoft.com.

• User config base password: This is the base password used for your application. For example, MyBasePassword123.

• Redirect URI: This is the URI to which Azure AD will redirect the user after authentication. For example, api://05b765c3-d64f-7704-b0d8-5c4c6bc674df

• User config resource URI: This is the URI of the resource (API, web app, etc.) that the application wants to access. For example, https://graph.microsoft.com.

• Azure Tenant ID: This is the identifier for your Azure AD tenant. For example, 72f988bf-86f1-41af-91ab-2d7cd011db47.

• User config base username: This is the base username used for your application. For example, MyUsername@contoso.onmicrosoft.com.

Once the configuration is done and saved, Next click on TEST CONFIGURATION to test if Cymmetri is able to connect to Azure Server.

Assign various Product Licenses to user

For assigning any sort of licenses to a user of various products two main policy map entries need to done as shown below:

• azureLicense: Need to provide license key for the product you wish to assign to the user

• usageLocation: This field needs a two-letter country code (ISO standard 3166). Required for users that are assigned licenses due to legal requirements to check for availability of services in countries. Examples include: US, JP, and IN.

The value for azureLicense can be obtained as explained below:

Once you click that it opens the page from which we can copy the product id from URL as shown below:

Once all the above configuration is done, on the same page in Cymmetri go to Assignments section and assign users to the application and ensure that these users are created in Azure's Microsoft Entra ID along with the Microsoft Teams license.

Pre-requisites:

Make sure you have the following information before you proceed further:

• Cymmetri login credentials

• Access to IIS (Internet Information Services) to install certificates.

  • Access to Windows Certificate Services

• Active Directory Essentials:

  • Server hostname and password

  • OU (Organisation Unit) name, if any

  • SSL ports need to be enabled on your side

  • Export the CA Certificate from Active Directory and import it into the Connector Server.

  • Make sure the certificate is installed on the Connector Server

Step 1 - Configure your Active Directory Certificate and export it to Connector Server

Exporting your Active Directory certificate to the Connector Server is a necessary and crucial step. This ensures that the Active Directory and Cymmetri Identity Server can communicate over LDAPS (LDAP over SSL). For this to happen, LDAPS requires a properly formatted certificate installed in your Active Directory Domain Controllers. Please refer to this link and follow the same steps: https://www.manageengine.com/products/active-directory-audit/kb/how-to/how-to-install-ssl-certificates-in-active-directory.html

Once the certificate has been imported per the above instructions, you must restart the application to apply the changes made.

Step 2 - Add a new Active Directory application to Cymmetri

• Navigate to the Identity Hub on the left navigation bar and click the Applications tab. You will see a list of existing applications.
• Click 'Add New', and you will find the entire list of all available applications.
• Search for Active Directory on the top right and click on it. You should see the Active Directory application sidebar on the right.
• The Application Label has a default name for the Active Directory application and can be changed according to your choice. Click 'Add Application' from the bottom right to add the Active Directory application to your Cymmetri profile.

You have now added an Active Directory application to Cymmetri.

Step 3 - Adding Policy Attributes

• After adding the Active Directory, the 'Configure Now' button is enabled. Click this button to start setting up your Active Directory application.
• Define which attributes should be fetched from your Active Directory. You can do that by going to the Policy Attribute section.

• Here below are shown some Active Directory attribute descriptions

Policy Attributes - Policy attributes are user attributes (field names) in the Active Directory.

• The policy attribute table is prefilled with standard Active Directory Attributes by default. Please verify if it works for you. If not, follow the below mappings for the provisioning to work.

1. telephoneNumber - mobile

2. sAMAccountName - login

3. givenName - firstName

4. mail - email

5. sn- lastName

6. cn - firstName

2.1 Adding new attributes

• If the standard list does not contain the attributes you want to include, you can add new attributes by clicking the 'Add new' button on the right.

• Fill in the attribute name, and description and click Save.
• Also, toggle the Active switch to enable this new attribute.

Besides the present policy attributes, you need to add a custom attribute in case you're going for group provisioning, i.e. memberOf attribute.

Step 4 - Map your Active Directory Attributes to Cymmetri

• Now that you've defined what attributes to fetch from Active Directory, you will map these to Cymmetri user attributes.

• On the same window, navigate to the policy map in the left navigation bar.

Policy Map - Mapping of Cymmetri and Active Directory attributes.

• You will see that the attributes are set to False by default. Our first step in the mapping process is to enable the attributes for syncing.

• Click on the edit button next to the 'Application Field' name.
• The 'Application Field' indicates the Active Directory field name, and the 'Cymmetri Field' indicates the Cymmetri field name.

• To map the attributes, we need to sync the attributes on create and update only. Hence, these checkboxes need to be checked.

• The 'Set default value' field accepts the default value you enter here if the field is empty in Active Directory.

• Next, click on the 'Update' button.
• Similarly, repeat this for all attributes.

• One exception is the sAMAccountName field. The 'Is User Principal' checkbox is enabled by default because it is the primary key (unique data) on the Active Directory side, and login is the primary key on Cymmetri side; leave it checked.

Some important policy map fields which need to be declared in the policy map are as follows.

• If any attribute is missing from the policy map but present in your policy attribute. Add it by clicking the 'Add Cymmetri Field' and follow the same steps to map it to the appropriate field.

• If you want to add a new field that is not present even in Cymmetri, click on the 'Add Custom Field' button. For group provisioning, the memberOf attribute must be configured with the memberOf attribute from the custom attribute.

Hook Configuration

Every organization has its own custom implementation scenarios such as duplicate checks for login id, emails and displaynames; similarly provisioning to specific AD OUs based on various conditions. Hooks allow to transform the data and execute the validation rules as per the custom implementation scenarios.

Step 5 - Configure the Connector Server

• The connector server is a tool that provides different connectors that enable various provisioning operations from different sources to Cymmetri. Below you may see that Cymmetri supports all the various lifecycle operations needed to seamlessly perform various user operations.
• In our case, we will prepare the connector server to work with the Active Directory source.

• Click Provisioning from the left navigation bar and enable application provisioning by sliding the slider button.
• Once you enable the application provisioning, you must take care of two configurations to successfully provision Active Directory data to Cymmetri.

1. Server Configuration - Consists of configuring the connector server.

• Enter the IP address of the host server and its password. The rest of the fields come pre-filled with default values; you can change them according to your use case. Next, click on the save configuration button.

1. User Configuration - Consists of all user settings like domain name, search filter, etc. We can also configure an OU (Organisational Unit) in this window.

Note - You would need to change the below fields as per your organisation:

1. Root suffix - Add your domain name here.

2. Principal Password - Add your server password here.

3. Server Hostname - Add your server name here.

4. Principal - Add your admin Display Name of the Active Directory.

5. The base context for user search - You can add your Organisation Unit here.

6. The base context for group search - Add the base context to enable group search

7. Server port - Ensure that it is set to 636 for push

8. Page size- Define pageable result count for users

9. SSL - True is SSL is configured

10. Trust all certs - True.

11. Disable User OU Movement - Provide the path for disabling OU movement here.

Click on the save configuration button. Next, click on test configuration to see a successful toast message if your configuration is successful.

While configuring, you might encounter errors like:

• Authentication exception - Failure due to incorrect username and password.

  • Solution - Keep all your necessary credentials handy and enter the details carefully

• Socket timeout - Connection refusal by the target system

  • Solution - Please ensure your network connections are accurate to avoid socket timeout errors.

• SSL issue - SSL issue occurs mainly if certificates are not configured correctly.

  • Solution - Follow the steps mentioned in Step 1 rigorously to import the Active Directory certificate to avoid SSL-related errors.

Step 6 - Start syncing users from Active Directory to Cymmetri

The last step of onboarding users is to add the users from Active Directory to Cymmetri by Reconciliation.

Pull Reconciliation

Pull users from your Active Directory to Cymmetri.

• Click the 'Reconciliation' tab on the left navigation bar on the same page.
• Next, click the 'Add New' button under the pull tab.
• Add the field name details, and give a name to the pull reconciliation.

  • The modes field is prefilled with 'FILTERED_RECONCILIATION'; keep it as it is. It specifies the mode of Reconciliation.

  • The Sync fields are a drop-down menu with Cymmetri attributes that need to be mapped with the Source attributes, that is, your Active Directory attributes. Choose the correct mappings for these fields.

  • Keep the Status as Active.

  • Types are prefilled with the User. Keep it as it is.
• You can define the conditions for the Pull Reconciliation. It specifies the different scenarios of the Reconciliation. All the tabs have the same options in the dropdown: IGNORE, UPDATE, DEPROVISION, PROVISION, UNLINK, LINK, ASSIGN, UNASSIGN.

Here is an example scenario:

• The options to choose in a Reconciliation operation depend on your use case and change accordingly.

• In this case, we have chosen to IGNORE the users that do not exist in your Active Directory but exist in Cymmetri. Also, IGNORE users who are present in both the systems. PROVISION the users that exist in your Active Directory but do not exist in Cymmetri.
• Hit the save button on the top left and click the 'Run now' button. The status of the recon changes to active.
• You can head to the users tab and check if users are synced. If the reconciliation is successful, the users start appearing in this tab.

Push Reconciliation

Sync your user data to Active Directory.

• Navigate to the push tab and click on 'Add New'.
• Repeat Steps 2 and 3 from Pull Reconciliation.
• Move towards the Search Filter and Add Criteria section on the page.

• Fill in all the user details like Department, Designation, User Type, Location, Manager, Group, if any, email and mobile number. Keep the account status slider in the unlocked option. Choose user status as 'Active'.

• Set the conditions for the Push Reconciliation.
• Click on Save at the top-right corner of the page.

• Click on 'Run-now' to start the Push Reconciliation. You can check the status on the Reconciliation page.

• Navigate to the users page to check the new users added to Cymmetri.

History

Navigate to the History tab to check and track the pull and push Reconciliation of the past.

Click on the eye icon to view the Push/Pull reconciliation operation.

All the details configured in the Push/Pull Reconciliation can be seen here. It also displays the Summary of Pending, Synced and Error records.

Logs

If, in any case, you're facing issues, head to the Logs->Audit Log to check for error logs.

• Click on the eye icon to check the event attributes in the audit log for errors.

Google Workspace is a software-as-a-service platform (SAAS) that provides email, calendar, documents and other services. This connector uses the Google Workspace provisioning APIs to create, add, delete and modify user accounts and email aliases.

Note: 1. Only the Premium (paid) or Educational versions of Google Workspace provide access to the provisioning APIs. 2. Connector will not work on the free Google Workspace Domain

Configuration

For Configuring Google Workspace for provisioning we need to first obtain the client_secret.json file from the Google Workspace instance.

Create New Project

Go To https://console.developers.google.com/ and create a new Project if not already created. A new project needs to be created because it allows you to manage the credentials required to access Google APIs and services securely. A new project can be created by clicking on the New Project on top right or by clicking on the the Resource Dropdown

And the on the NEW PROJECT link on top right

Next enter the Project name and select Organisation and Location as shown below and click on CREATE button

ADMIN SDK API:

The Admin SDK API is needed to programmatically manage and interact with various aspects of a Google Workspace domain, such as users, groups, organizational units, and settings. Here are some key reasons why the Admin SDK API is essential:

1. User Management: The Admin SDK API allows you to create, retrieve, update, and delete user accounts in your Google Workspace domain. You can manage user details such as name, email address, password, and organizational unit.

2. Group Management: You can create, retrieve, update, and delete groups within your Google Workspace domain using the Admin SDK API. This includes managing group members and settings.

3. Organizational Unit Management: The API enables you to manage organizational units (OUs) within your Google Workspace domain. You can create, retrieve, update, and delete OUs, as well as move users and groups between OUs.

4. User Reports: The Admin SDK API provides access to various reports about user activity, such as login activity, email sending/receiving activity, and more. These reports can help you monitor and analyze user behavior within your domain.

5. Settings Management: You can manage various domain-wide settings, such as email routing, calendar sharing settings, and device management settings, using the Admin SDK API.

6. Security and Compliance: The API provides features for managing security and compliance settings within your Google Workspace domain, such as 2-step verification, password policies, and audit logs.

To enable ADMIN SDK API click on Enabled API & Services and Search for Admin SDK API:

Click on Admin SDK API and then click on the Enable button

Once enabled, Click on CREDENTIALS tab

Now click on Credentials section and click on CREATE CREDENTIALS button and in that select OAuth client ID option

Select Desktop app as Application type, provide a name for the OAuth 2.0 client and then click on the CREATE button

A response screen is visible that shows that the "OAuth client created" It also displays Your Client ID and Your Client Secret. You may download the JSON here using the DOWNLOAD JSON option.

Click on OAuth consent screen and then Click on EDIT APP. Enter the required details and Click on SAVE AND CONTINUE button

Select Internal as User Type if you want to restrict access only to the users of your organization.

Search for Admin SDK API on the Scopes screen and select scope for user: .../auth/admin.directory.user

Select the scope for group: .../auth/admin.directory.group

Next Click on Credentials section and downlaod OAuth client json file on your local machine by clicking on the Download OAuth client button.

Next download thenet.tirasa.connid.bundles.googleapps-1.4.2.jarbundle for Google Workspace from the Connector Server website. Once downloaded open a new command prompt and change to the directory where you have downloaded the bundle and run the following command on the client_secrets.json file that you obtained earlier step:

$ jar xvf net.tirasa.connid.bundles.googleapps-1.4.2.jar
$ java -jar net.tirasa.connid.bundles.googleapps-1.4.2.jar /path/to/client_secrets.json
Please open the following address in your browser: ?
access_type=offline ...

This command opens the default browser, and loads a screen on which you authorize consent to access the Google Apps account. When you have authorized consent, the browser returns a code. Copy and paste the code into the terminal from which you ran the original command

Attempting to open that address in the default browser now... 
Please enter code: XXXXXXXX

A response similar to the following is returned.

Once the above information is obtained we need to configure the Google Workspace in Cymmetri with Server Configuration and User Configuration as shown below:

Once the configuration is done click on TEST CONFIGURATION button to check if the configuration is working.

Once the test is successful next go to the Assigments section and assign the application to a user as shown below:

Once assigned ensure that the user is created in Google Workspace.

Integration with LDAP

1. For LDAP connector integration we need an LDAP server with the following detail sample.

   Host/IP

   LDAP Base Context

   service user (Manager Username)

   password (Manager User password)

2. After configure LDAP server we need to configure the Ldap application into the Cymmetri.
3. Check policy map to add proper attributes as needed by LDAP schema.

Integration with Powershell

1. For the powershell connector we need a windows server machine with a connId server on it.

2. Configure powershell connector with following properties
3. Must configure powershell script with valid data using the reference below

Reference: https://drive.google.com/drive/folders/1XHt6aNmPzs7V7OKesk31FwqLxGf3u2ST?usp=sharing

Integration REST Application

1. The REST connector is designed to manage provisioning by relying on RESTful service.

2. For REST applications we need target applications which support REST API’s.

3. Following configuration is tested for felicity application.

4. We need REST API’s to integrate with cymmetri.

5. Following are the cymmetri configuration which need to configure in user configuration in cymmetri.

6. It is Basic REST configuration which need to configure in application.

1. We need to provide Groovy code to run create user, update user, delete user and also recon pull and push (for recon pull we need to add sync script and for recon push we need to add search script)

2. For sample script please validate following link

https://drive.google.com/drive/folders/1Vs8y1ZHXV3AjqsPkQSnwUoVppL-yc8Vl?usp=sharing

Note: Please Configure script step by step

1. Configure test script at initial step and then test configuration for provided script (If configure successfully then only go for step b).

2. Configure create script and test configuration (If successfully configured then only go for step c).

3. Configure update script and test configuration (If successfully configured then only go for step d).

4. Configure delete script and test configuration (If successfully configured then only go for step e).

5. Configure sync(pull) script and test configuration (If successfully configured then only go for step f).

6. Configure search(push) script and test configuration (If successfully configured then only go to the next step).

Integration SCIM v2.0 with Basic

1. Any application which supports SCIM v2.0 with basic authentication is workable for application.

2. Following are configuration which is used for SCIM with basic authenticator.

1. Base address - It is the endpoint of the target system which supports SCIM v2 API’s.

2. Username - Username to authenticate SCIM API endpoint.

3. Password - Password to authenticate SCIM API endpoint.

4. Authentication type - It is Fixed Bearer compulsory.

5. Update method - Patch or Put method.

6. Accept - Http header which accepts (application/json etc).

7. Content Type - Http header which accepts (application/json etc).

1. Any application which supports SCIM v2.0 with bearer token is workable for application.
2. Following are configuration which is used for SCIM with bearer.

   1. Base address - It is the endpoint of the target system which supports SCIM v2 API’s.

   2. Username - Username to authenticate SCIM API endpoint.

   3. Password - Password to authenticate SCIM API endpoint.

   4. Security Token - It is a token which is used to authenticate.

   5. Grant Type - It is grant type which is used to grant access for API’s.

   6. Client Id - client id for authentication

   7. Client Secret - client secret for authentication

   8. Authentication type - It is Fixed Bearer compulsory.

   9. Update method - Patch or Put method.

   10. Accept - Http header which accepts (application/json etc).

   11. Content Type - Http header which accepts (application/json etc).

   12. Access Token Base Address - base address for access token

   13. Access Token Node Id - node id for access token

   14. Access Token Content Type - content type for access token.

Github Enterprise provides provisioning using SCIM 2.0

Pre-requisites

1. Create an account in Github (Enterprise).

2. Enable SAML for the Github tenant to be used with Cymmetri.

Step 1. Configure SSO in Cymmetri

Note the application URL received from the Git SAML configuration

Continue the configuration by logging into Cymmetri using at least Application Administrator role

Note: Public certificate gets from SSO metadata(cymmetri) and format it using following

Note: Make sure when you test SAML then in cymmetri login with github admin users loginid which is added in cymmetri.

Configure Profile Mapping

Create User in Cymmetri and make sure login id of Cymmetri is same as gitHub Admin user login id.

Test SSO with the Cymmetri user.

1. Configure SCIM v2.0 (Github) application from master (cymmetri).

2. Basic provisioning policy attribute and policy map already aaded in default schema.

3. Github Application is run using Fixed Bearer token.

4. To get Fixed bearer token following steps used.

Step 1: Go to user settings in github

Step 2: Go to developer settings

Step 3: Go to personal access token and generate new token

Step4: Click on Configure SSO

Step 5: Click on Authorize

1. Use following cymmetri provision configuration and change according to github account.

2. Fixed Bearer Value copy from personal access token

3. Click on save

4. Click on Test Configuration with success message.

5. Check Policy map

6. Disable default for the respective attribute

To configure ServiceNow Application with cymmetri we need to configure Active Directory application. Please follow the steps provided below.

1. Get ServiceNow application from Cymmetri Master apps.

1. After Getting application from cymmetri master activate provisioning of selected application i.e Service Now.

2. After successfully activating provisioning, setup server configuration.

Note: Basic configuration is already provided in cymmetri master application. If the connid server is configured externally then configure server config as per requirement.

1. Successfully configuring server configuration, next step is to configure User Configuration. This is the most important step to connect and perform operations with Service Now.

For User configuration we need User config base address,User config username and User config base password for all these credentials first we need to create account in Service Now which is a target application

Create account by clicking on below link

After clicking continue we have to enter a verification code which we will get from the entered email address.

Now we can go to Service Now account and click on My Profile and setting

it again asking for verification code.

Enter the verification code and verify the account.

Then click on Developer Program option

Now check the job responsibilities for admin account as shown in the screenshot

Now click on “Start building” tab for setting up an instance.

After setting up an instance we will get credentials for configuring the service now.

Add these credentials to the user configuration and save and test the configuration.

Now we have to add the policyAttribute which is not available. Go to policyAttribute and click on Add New button.

After clicking on the new button we have to add policyAttribute.

Now we also need to map the policyAttribute name and description and save it.

After completing policyAttribute we need to map these attributes with the cymmetri fields.

Go to policyMap and for user policyMap click on AddCymmetriField.

After clicking Add Cymmetri Field, window will open

Click application field and select field which we want to map with cymmetri field (Select Cymmetri Field) and check create Only and Update Only tab and if we want to make any field as unique field then check Is User Principal checkbox and save it.

Map remaining field as above just remember which field is unique(is user Principal marked checked).

After all configuration with these above steps now we are able to assign Service Now Application to the user. To check whether a user created or not to the target application we need to go to Service Now account click on All and search for Users

Here we will get all the user list.

AMAYA is Cymmetri's no-code/low-code provisioning tool designed to streamline and simplify the provisioning process for users. This tool allows administrators to create, manage, and automate user provisioning workflows without needing extensive coding knowledge.

The AMAYA application within Cymmetri is designed to facilitate the provisioning of users and groups to various target systems through a series of configurable operations. This application supports a variety of operations to manage the lifecycle of user identities, including testing a connection to target system, syncing, searching, creating, updating, deleting, and managing roles.

Application Provisioning

The Application Provisioning interface for AMAYA is divided into several tabs:

User Configuration

Lets you configure the various user identity operations quickly and without coding

This interface allows administrators to configure and manage how users and groups are provisioned to or from target systems like Slack, Azure, ServiceNow, etc.

AMAYA Key Operations

• Test Operation: This operation is used to test the configuration with the target system. It ensures that the setup is correct and that the AMAYA application can communicate with the target system.

• Sync Operation: This operation is used to synchronize users or groups from the target system. It ensures that the user/group data in Cymmetri is consistent with the data in the target system.

• Search Operation: This operation allows administrators to search for users or groups in the target system, making it easier to find specific entities.

• Create Operation: This operation is used to create users or groups in the target system based on the information in Cymmetri.

• Update Operation: This operation allows for updating the details of existing users or groups in the target system, ensuring that changes made in Cymmetri are reflected accurately.

• Delete Operation: This operation is used to delete users or groups from the target system, removing access or decommissioning identities as required.

• Role Assign Operation: This operation assigns roles to users or groups in the target system, helping to manage permissions and access levels.

• Role Unassign Operation: This operation unassigns roles from users or groups in the target system, removing permissions as necessary.

Quick Setup with Predefined Templates

The second image shows the Quick Setup screen, which provides predefined templates for popular applications. These templates simplify the process of setting up provisioning by offering pre-configured settings for the following applications:

• Slack

• ServiceNow

• HubSpot

• Azure

• AWS Identity Center

Administrators can quickly start with these templates, which have standard configurations, and customize them as needed to suit their specific requirements. The search function at the top allows users to find other applications if the needed one is not listed among the predefined templates.

Server Configuration

Consists of configuring the connector server. Enter the IP address of the host server and its password. The rest of the fields come pre-filled with default values; you can change them according to your use case.

Operations

This tab shows the list of operations supported by AMAYA

• Hook Configurations If the administrator needs to write some custom action before and/or after provisioning the application, that can be enabled by configuring web hooks as shown in the Hook Configuration. The configuration supports a PRE and a POST HOOK for triggering custom code before and/or after provisioning of the application. Refer to webhooks here

1. Any application which supports SCIM v2.0 with fixed bearer is workable for application.

2. Following are configuration which is used for SCIM with fixed bearer

1. Base address - It is the endpoint of the target system which supports SCIM v2 API’s.

2. Username - Username to authenticate SCIM API endpoint.

3. Password - Password to authenticate SCIM API endpoint.

4. Authentication type - It is Fixed Bearer compulsory.

5. Fixed Bearer Value - The value for fixed bearer.

6. Update method - Patch or Put method.

7. Accept - Http header which accepts (application/json etc).

8. Content Type - Http header which accepts (application/json etc).

In Cymmetri, database provisioning involves setting up and managing database access for provisioning users from the Database Management System into Cymmetri.

Configuration

To configure a Database application for provisioning we need a database on the server. We need one table in the database on which we want to create users.

In the above image Userdetails is a table with some basic fields.

Configuring the Database Application

To configure Database Application with cymmetri we need to configure ScriptOn (Database) Application. Please follow the steps provided below.

1. Get ScriptOn (Database) Application from Cymmetri Master apps list
2. After Getting application from Cymmetri Master activate provisioning of selected application i.e ScriptOn application (Database).After successfully activation of provisioning, setup server configuration.

Note: Basic configuration is already provided in cymmetri master application. If the connid server is configured externally then configure server config as per requirement.

1. After successfully configuring server configuration, next step is to configure User Configuration. This is the most important step to connect and perform operations with ScriptOn (Database) applications.

2. To configure User configuration please refer to the following steps (It is abstract level steps that may be vary as per client). Following are the basic configuration which is required for every ScriptOn (Database) application to connect.

   1. Database :- Name of the database on the database server that contains the table.
   2. Datasource Path :- JDBC Data Source to connect to the database server.

   3. Host :- The name of the host where the database is running.(eg localhost or 10.0.1.7)
   4. JDBC Driver :- The JDBC Driver class name.

      Eg: For Oracle Driver Class Name is oracle.jdbc.driver.OracleDriver For MySQL is org.gjt.mm.mysql.Driver For PostgreSQL is org.postgresql.Driver
   5. JDBC Connection URL :- Specify the JDBC Driver Connection URL. Examples: Oracle: jdbc:oracle:thin:@[host]:[port(1521)]:[DB] MySQL: jdbc:mysql://[host]:[port(3306)]/[db] PostgreSQL template is jdbc:postgresql://[host]:[port(5432)]/[db]

   6. Db is a database name. It Could be empty if a datasource is provided.
   7. User Password :- User account that has permission to access accounts table.

   8. Port :- The port number the database server is listening on. For postgreSQL it could be 5432. For mysql it could be 3306. We need to use it according to our database.

   9. Reload Script On Execution :- This flag value must be true if we pass scripts file name (Groovy Scripts upload in server)

   10. User :- The name of the mandatory Database user with permission to the account table.

   11. Test Script or Test Script File Name :- Test script for testing connection from database with Cymmetri

   12. Create Script or Create Script File Name :- Create user script for creating user in database application (supports PostgreSQL, MySQL, Oracle 11g) <uid needs to return from create script>

   13. Update Script or Update Script File Name :- Update user script for updating user in database application (supports PostgreSQL, MySQL, Oracle 11g) <user update based on uid>

   14. Delete Script or Delete Script File Name :- Delete user script for deleting user from database application (supports PostgreSQL, MySQL, Oracle 11g) <user delete based on uid>

   15. Search Script or Search Script File Name :- Search script for searching user from database (Bulk search)

   16. Sync Script or Sync Script File Name :- Sync script for Synchronizing users from database into/from cymmetri.

Above are the most important fields in user configuration which need to be configured. The details for the above fields are given in the application configuration page.

1. Configuring all the user and server configuration with proper data and Test application for connectivity. If it is successful then we can proceed for assignment and reconciliation operations or if it fails then check the audit log for error.

2. Other than user and server configuration we need Policy Attribute and Policy Map for mapping attributes of Database application with Cymmetri.

3. Following are the steps to configure policy attribute and policy map.

   1. Policy Attribute :- There is default policy attribute cymmetri master application provides which has basic fields which needs to be configured for performing provisioning operation.

1. To add a new policy attribute click on the new button and add policyAttribute and its description.
2. Policy Map :- There is default policy map present in cymmetri master application which provides basic mapping of ScriptOn (Database) application with cymmetri. To configure these mapping we need to activate it as in create only and update only flags need to be true as per requirement.
3. To add a new policy map click to Add Cymmetri field.

1. Some important policy map fields which need to be declared in the policy map are as follows.

   1. __NAME__ :- users login (supports from ‘cloud_2.7.21’)

   2. __PASSWORD__ :- users password (supports from ‘cloud_2.7.21’)

2. For sample script please validate following link

https://drive.google.com/drive/folders/1-XSIlHSnf6UM0JYiaysA5Vg-TdfrMe0I?usp=drive_link

1. We need to provide Groovy code to run create user, update user, delete user and also recon pull and push (for recon pull we need to add sync script and for recon push we need to add search script)

Note: Please Configure script step by step

1. Configure test script at initial step and then test configuration for provided script (If configure successfully then only go for step b).

2. Configure create script and test configuration (If successfully configured then only go for step c).

3. Configure update script and test configuration (If successfully configured then only go for step d).

4. Configure delete script and test configuration (If successfully configured then only go for step e).

5. Configure sync(pull) script and test configuration (If successfully configured then only go for step f).

6. Configure search(push) script and test configuration (If successfully configured then only go to the next step).

NOTE :- While configuring the database you need to add a jdbc jar for a particular database into connid server (Inside the lib folder of the connid server).

Darwin Box Provisioning in Cymmetri involves integrating the Darwin Box HR management system with Cymmetri's identity and access management platform to automate and streamline user provisioning processes.

Configuration

• Add the Darwin Box application from the master and Enable the application provisioning.

• Next we do User and Server Configurations

User Configuration:

1. Api Key: <api_key_value>

2. Username: <username>

3. Password: <password>

4. Dataset Key: <dataset_key_value>

5. Unique key: employee_id

6. Base Address: <base_address_value>

7. Full Sync: <Select accordingly if want to do full sync or partial sync>

Server Configuration:

1. Host Server: 10.0.1.8

2. Server Password: <password>

3. Server Port: 8760

4. Server Connector bundle name: darwinBoxRest

5. Server Connector bundle version: 1.0

6. Server Connector name: com.cymmetri.connector.darwinBoxRest.DarwinBoxRestConnector

Add custom attributes (optional):

1. Group Company

2. Function

3. Office Area

4. Work Area Code

5. Office City

6. Direct manager employee id

7. Office mob no

8. Centre type

9. Office State

10. Office Address

Add policy attributes in application

1. first_name

2. last_name

3. employee_id

4. departments_hierarchy

5. company_email_id

6. designation_title

7. office_country

8. group_company

9. function

10. office_area

11. work_area_code

12. office_city

13. direct_manager_employee_id

14. office_mobile_no

15. center_type

16. office_state

17. office_address

Map the policy attributes

1. employee_id with login

2. first_name with firstName

3. last_name with lastName

4. company_email_id with email

5. employee_id with employeeId

6. group_company with Group Company

7. function with Function

8. departments_hierarchy with department

9. office_area with Office Area

10. work_area_code with Work Area Code

11. office_city with Office City

12. office_country with country

13. direct_manager_employee_id with Direct manager employee id

14. office_mobile_no with Office mob no

15. center_type with Center type

16. office_state with Office State

17. designation_title with designation

18. office_address with Office Address

Create a reconciliation

Create and Run the reconciliation pull.

Custom Script for date

Add the following script for date conversion in hook config

Note:

1. For now, only sync operation is supported for Darwin Box.

2. Unique key is considered as an employee id.

Cymmetri provides a connector to remotely connect to a data source using SFTP and fetch flat-files to manage application user assignment data in Cymmetri. database provisioning involves setting up and managing database access for provisioning users from the Database Management System into Cymmetri. The CSV Directory can import common data types such as Comma Separated Values, Delimited Files or Flat-files from a configured location.

Configuration

To configure the CSV Directory with Cymmetri we need to configure the CSV Directory application. Please follow the steps provided below.

First we need to create one CSV file locally then we need to place this file in the server.

For example if we connected to the server 10.0.0.99 then we need to place the csv file on that server. For example, we can transfer the file through the WinSCP application as well.

Click on the CSV Directory application from Cymmetri application catalogue

1. After Getting application from Cymmetri master activate provisioning of selected application i.e. CSV Directory.

2. After successfully activating provisioning, setup server configuration.

Note: Basic configuration is already provided in Cymmetri master application. If the connector server is configured externally then configure server config as per requirement.

1. Successfully configuring server configuration, next step is to configure User Configuration. This is the most important step to connect and perform operations with CSV Directory.

There are some fields which are compulsory

Source Path: Absolute path of a directory where the CSV files to be processed are located.

File Mask: Regular expression describing files to be processed. It can be the name of the csv file name.

Key Column Names: Name of the column used to identify user uniquely

Ignore header: Specify it first line file must be ignored

Column names: Column names separated by comma

Here the column name is the same as csv files column name.

Field Delimiter: Delimiter used to separate fields in CSV files

Key separator: Character used to separate keys in a multi-key scenario

Now fill the above fields and save the configuration and test the configuration.

Now we have to add Policy Attribute as per requirements. Go to Policy Attribute and click on Add New button.

After clicking on the new button we have to add Policy Attribute.

Now we also need to map the Policy Attribute name and description and save it.

After completing Policy Attribute we need to map these attributes with the Cymmetri fields.

Go to Policy Map and for user Policy Map click on Add Cymmetri Field.

After clicking Add Cymmetri Field, window will open

Inside User Configuration, add the Base Addresses of the target system SOAP APIs and add the Create, Update, and Delete Groovy Scripts. These scripts will perform the related CRUD operations at the target system using SOAP.

It is an example where the Create Script will be added. Similarly, add the other Scripts under the User Configuration

Add Relevant Connector Server, Port, and other details under the server configuration tab.

a. Set up Policy Attributes.

Go to the Policy Attributes on the left side menu. Add the user attributes that need to be involved in the CRUD Operations as named in the target system.

b. Set up Policy Map

This corresponds to the mapping of the fields in the target system with Cymmetri Fields

Step 1: Add and configure a new Custom Web Services Application

a. Go to Applications > Add New > Change Application Label > Click on Add Application.

This will add the application to be provisioned.

b. Set up Application Provisioning

Once the application is added, open the application and click on the provisioning

To add a mapping, click on the add Cymmetri field and add the field details.

Application Field - Field name of the target application

Cymmetri Field- Field name in the Cymmetri.

Check Is USER Principal option for the uniqueness of that particular field as per the target system,

Check Create Only and Update Only if the CREATE/UPDATE operation is required for that field.

Click on Save.

Now the application is ready for provisioning.

Step 2: Add/Update/Delete Application to the User.

Go to the user to whom the application needs to be assigned. Click on the add new button. Now select the newly created application for provisioning and click on assign.

Configure the Application Access Details and click on Save

Now User is Assigned to the target application.

Along with the Cymmetri adding the target application and its details to its database, the target application too will save the user details of the cymmetri.

Sending the details to the target application is done using a rest connector whose configuration is done under the provisioning section in step 1. This rest connector has groovy scripts for CRUD Operations.

The create groovy script is used to create the user in the target application. This create script prepares the required payload by referring to the policy attributes and policy mapping and calls the target system’s CREATE API. The target application returns a UID which is used for future purposes like update and delete.

We can edit the user details from the user profile. Along with updating the details into Cymmetri this will call the Update Groovy Script present in the User Configuration and perform the update operation in the target application for the user.

Delete a User is deprovisioning the user from the application. This is done using the delete option. This calls the delete groovy script to remove the user from the target application thus deprovisioning it. Once deleted the user is removed from the target system.

Step 3: Reconciliation/Syncing(PULL) user data into Cymmetri from the Target System.

The synchronization code is written inside the sync Groovy script. Sync Script fetches the user data from the target system and passes it to the Cymmetri, which further processes it according to the reconciliation condition specified.

Reconciliation is started by creating a reconciliation object under the tab mentioned below.

Click on ADD New to create a new Reconciliation PULL object. Add the cymmetri(Sync Field) and Target field (Source Attributes) mapping against which the sync action will be performed.

Now specify the pull conditions as per the requirement and click on save. A new recon object is created.

Click on the edit option on the recon object to run the reconciliation.

Clicking on Run Now will trigger the reconciliation PULL Process.

Reconciliation history can be checked under the history tab.

Assumptions and Observations

· The Target Application considered is any SOAP API and the groovy scripts are created to call these soap APIS.

· CRUD and Sync Groovy Scripts added in this Word document remain the same except for a few changes.

a. The request body of the target system to be sent will change. It will be in the form of a String XML.

b. The Sending/Receiving Response of the SOAP web services will remain the same.

c. Once the XML response is received from the SOAP API, this response has to be parsed into JSON by reading the child nodes of the XML.

d. After a user is created into the target system using the create groovy script, the user ID received in the xml response has to be parsed and saved. This UID is used later for update/delete operations.

e. Sync records received from target soap API has to be parsed and collected into an array and passed to the Cymmetri.

Overview

This page outlines the process for integrating your Service Desk platform with Cymmetri. This integration will streamline workflows, enhance communication, and improve overall service management.

Prerequisites

Before beginning the integration, ensure you have:

• Administrative access to both the Service Desk and Cymmetri.

• API keys or authentication tokens for both platforms.

• Backup of existing configurations, if necessary.

Step 1: Configure Your Service Desk

1. Login to Your Service Desk

   • Access your Service Desk portal and log in with your admin credentials.

2. Access API Settings

   • Navigate to Settings > API.

   • Enable API access if it is not already enabled.

   • Generate an API key if you do not have one.

3. Record API Endpoint

   • Note the API endpoint URL (e.g., https://your-servicedesk.com/api/v1/).

Step 2: Configure Cymmetri

1. Login to Cymmetri

   • Go to your Cymmetri dashboard and log in as an administrator.

2. Access Integration Settings

   • Navigate to Identity Hub > Applications.

   • Click on Add New Application.

3. Select Service Desk

   • Choose your specific Service Desk platform from the list of available integrations. Cymmetri has ready connectors for ServiceNow, Atlassian (Jira), Fresh Service, etc.

4. Enter API Details

   • API URL: Enter the API endpoint noted from your Service Desk.

   • API Key: Paste the API key generated in your Service Desk.

5. Test Connection

   • Click on Test Connection to ensure Cymmetri can successfully communicate with your Service Desk.

   • If successful, proceed to the next step. If not, double-check your API settings.

Step 3: Map Data Fields

1. Field Mapping using Policy Map

   • Map relevant fields between your Service Desk and Cymmetri. Common fields to consider include:

     • Ticket ID

     • Status

     • Priority

     • Assignee

     • Comments

2. Configure Sync Settings

   • Decide on the synchronization direction (one-way or two-way).

   • Set the sync frequency (e.g., real-time, hourly, daily).

Step 4: Setup Notifications (Optional)

1. Notification Configuration

   • Set up notifications for important events (e.g., ticket creation, updates).

   • Choose how notifications will be delivered (email, in-app alerts).

Step 5: Testing the Integration

1. Create Test Tickets

   • Create several test tickets in your Service Desk.

   • Confirm that these tickets are reflected in Cymmetri as expected.

2. Update Test Tickets

   • Modify the status or comments of the test tickets in either system and check if the changes sync properly.

Troubleshooting

• Connection Issues: Double-check API keys and endpoint URLs. Ensure both systems are operational.

• Data Sync Problems: Review field mappings and sync settings. Check integration logs for errors.

Cymmetri can work with systems that handle user account provisioning manually, such as help desk or service request platforms. These systems typically rely on human intervention to create, modify, or deactivate user accounts, and Cymmetri can communicate or integrate with them to streamline these processes.

For example: If a company hires a new employee, the help desk team manually creates an account for the employee. Cymmetri connects with this help desk system to track or manage the account creation process.

Manual Application Provisioning Workflow

Cymmetri provides a robust suite of provisioning operations that enable seamless identity and access management across various applications. Below is a detailed overview of the provisioning operations supported by Cymmetri.

1. Test Operation

• Purpose: The Test Operation is used to validate the connectivity and configuration settings between Cymmetri and the target application or directory service. This operation ensures that all necessary parameters, such as API endpoints, credentials, and schema mappings, are correctly configured.

• Usage Scenario: Before initiating any provisioning tasks, administrators can use the Test Operation to verify that the integration between Cymmetri and the target system is functioning as expected.

2. Sync Operation

• Purpose: The Sync Operation synchronizes user and group data between Cymmetri and the connected applications. This operation ensures that the identity information in Cymmetri is in sync with the data in external systems.

• Usage Scenario: The Sync Operation is typically scheduled to run at regular intervals or triggered manually to ensure that changes in the external system (e.g., new users, updated roles) are reflected in Cymmetri.

3. Search Operation

• Purpose: The Search Operation allows administrators to query the target application or directory for specific users or groups. This operation is essential for identifying and managing specific identities in the external system.

• Usage Scenario: Administrators can use the Search Operation to find users based on attributes such as username, email, or group membership, facilitating targeted management tasks like updates or deletions.

4. Create Operation

• Purpose: The Create Operation is used to provision new user accounts or groups in the target application or directory based on the identity data maintained in Cymmetri.

• Usage Scenario: When a new employee joins an organization, the Create Operation can be triggered to automatically provision their account in various applications, ensuring immediate access to necessary resources.

5. Update Operation

• Purpose: The Update Operation allows administrators to modify existing user or group attributes in the target system. This operation is crucial for maintaining accurate and up-to-date identity information across systems.

• Usage Scenario: If an employee's role changes, the Update Operation can be used to modify their access privileges or update their profile information in connected applications.

6. Delete Operation

• Purpose: The Delete Operation is used to de-provision user accounts or groups from the target application or directory. This operation is essential for removing access when users leave the organization or no longer require certain resources.

• Usage Scenario: Upon the termination of an employee, the Delete Operation can be triggered to remove their accounts from all connected applications, ensuring security and compliance.

7. Role Assign Operation

• Purpose: The Role Assign Operation assigns specific roles to users in the target system, granting them access to particular resources or permissions.

• Usage Scenario: When an employee is promoted to a managerial position, the Role Assign Operation can be used to grant them additional access rights aligned with their new responsibilities.

8. Role Unassign Operation

• Purpose: The Role Unassign Operation removes previously assigned roles from users, revoking their access to certain resources or permissions.

• Usage Scenario: If an employee is reassigned to a different department, the Role Unassign Operation can be utilized to revoke roles that are no longer relevant to their new position.