Configuring custom attributes in connectors
Configuring custom attributes in connectors
This section describes the steps to configure custom attributes using Starling Connect for connectors.
To configure a custom attribute:
- Navigate to the configured connector in the Active Connectors section.
- Click the connector tile.
The General Configuration and Schema Configuration are displayed.
- Click EDIT.
The Schema Configuration displays the Custom Attributes section, where you can configure the custom attributes.
NOTE: If you have already configured any custom attributes, they are displayed in the Custom Attributes section.
- Select the object under which you want to create the custom attribute.
- In the Custom Attributes section, enter the appropriate values in the following fields:
- Data Type
- Target System Attribute name
- Description
NOTE:
Choose the required option from the available list of data types in the Data Type field
- Binary
- Boolean
- DateTime
- Decimal
- Integer
- String
- Click SAVE.
NOTE:
- To configure another custom attribute, click ADD ATTRIBUTE.
- To remove a custom attribute, select the custom attribute and click Remove.
- To modify and existing custom attribute, click the custom attribute and enter new configuration details.
- Enter the configuration details in the General Configuration section and click Test Connection.
- Click SAVE.
The newly created custom attribute is displayed in Custom Attributes section and is available in One Identity Manager.
NOTE:
- In SuccessFactors HR connector, if a custom attribute is a part of navigation, then you must enter it in the following format in Starling Connect: <navigation>$$<custom_attribute>. For example, you must enter userNav/dateOfBirth as userNav$$dateOfBirth in Starling Connect.
- The SuccessFactors HR connector supports single level of navigation only.
Disabling attributes
The Disable attribute feature can be used when you want to skip an attribute that exists in the target system.
NOTE: Mandatory attributes cannot be disabled.
This section describes the steps to disable an attribute using Starling Connect.
To disable an attribute:
- Navigate to the configured connector in the Active Connectors section.
- Click the connector tile.
The General Configuration and Schema Configuration are displayed.
- Click EDIT.
The Schema Configuration highlights the attributes that can be disabled.
NOTE: You cannot disable mandatory attributes. Mandatory attributes are suffixed with a *.
- Toggle the attribute that you want to disable.
NOTE: If you disable a parent attribute, all its child attributes are disabled.
- Enter the configuration details in the General Configuration section and click Test Connection.
- Click SAVE.
The disabled attribute is removed from the SCHEMA responses and requests of the following operations:
Operation |
From |
GET Schema |
Response |
Get <object> by Id |
Response |
Create <object> |
Response
Request (which is sent from the connector to the cloud application) |
Update <object> |
Response
Request (which is sent from the connector to the cloud application) |
NOTE: In the above table, <object> represents a connector endpoint.
Configuring a connector that uses the consent feature
Configuring a connector that uses the consent feature
This section describes the procedure to configure a connector that uses the consent feature.
To configure a connector that uses the consent feature
- Enter the configuration details in the General Configuration.
NOTE:
- Each connector requires a different set of configuration details. For more information about the configuration details for each connector, navigate to the section Supervisor configuration parameters for the connector that you want to configure, in this document.
- Every connector license that you have, allows you to configure two different connections, one in the Production environment and the other in the Development environment. Hence, you can configure the connector to create a Starling Connect connector connection in your Development environment for testing, and then, configure it in your Production environment.
- Click Give Consent.
NOTE:
- To provide consent, use an account with administrative privileges.
- For more information about the necessary permissions required to configure each connector, navigate to the section Connector configuration for the connector that you want to configure, in this document.
- Click Test Connection.
- Click Save.
Synchronization and integration of Roles object type with One Identity Manager
Synchronization and integration of Roles object type with One Identity Manager
This section describes the synchronization and integration of Roles object type with One Identity Manager.
To synchronize and integrate Roles object type with One Identity Manager:
-
Ensure that the Roles endpoint of Starling Connect Connector returns the list of Roles from the target instance.
-
Create a mapping for Roles endpoint.
To create a mapping for Roles endpoint:
-
Open Synchronization Editor.
-
Select the project.
-
Navigate to the Navigation pane.
-
In the Navigation pane, click Configuration.
-
In the Navigation pane, click Target system.
-
Click Update Schema in the General section.
-
In the Navigation pane, click Mappings.
-
Create a new mapping named Roles.
To create a new mapping, click + in the Mappings section.
-
In the Create map window, enter the values for all the fields, including the display name, in the following sections :
-
Click OK.
-
Click Next.
- In the Mapping Wizard window, in the Select task section, select the required template. For example, Group template.
-
Create a new Fixed-value virtual attribute at the target system side with the name vrtRoles, for example.
To create a Fixed-value virtual attribute:
- Click + at the target system side in the SCIM section.
- In the Create property window, enter the values for all the fields.
The value of the Value field must be Profiles.
-
Configure Mappings.
To configure Mappings:
-
Map Item type <- vrtRoles.
-
Map Ident_UCIItem <- name.
-
Create Synchronization workflow for Roles.
NOTE: The procedure to Create Synchronization workflow for Roles is similar to the procedure to Create Synchronization workflow for Users and to Create Synchronization workflow for Groups.
-
Create Provisioning workflows for Roles.
NOTE: The procedure to Create Provisioning workflow for Roles is similar to the procedure to Create Provisioning workflow for Users and to Create Provisioning workflow for Groups.
-
Run Synchronization.
-
Perform assign or unassign of Roles at Users and Groups.