From ICIHelp7.15
Jump to: navigation, search
 
(9 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
= System for Cross Domain Identity Management (SCIM) =
 
= System for Cross Domain Identity Management (SCIM) =
  
−
ICM is now providing support for System for Cross-domain Identity Management (SCIM), which is an open standard protocol to automate the provisioning and deprovisioning of users. This framework allows exchange of user identity and user group information between identity providers (such as OKTA) and service providers (such as ICM – SaaS-based application). As a single system is used to manage permissions and groups, and data is transferred automatically, the risk of error is considerably reduced. This makes user management simpler and easier for customers. 
+
ICI is now providing support for System for Cross-domain Identity Management (SCIM), which is an open standard protocol to automate the provisioning and deprovisioning of users. This framework allows exchange of user identity and user group information between identity providers (such as OKTA) and service providers (such as ICI – SaaS-based application). As a single system is used to manage permissions and groups, and data is transferred automatically, the risk of error is considerably reduced. This makes user management simpler and easier for customers. 
  
−
OKTA integrates various applications into its service, and you simply deploy these pre-integrated applications to your users as necessary. For example, OKTA uses the SCIM application to provision users or user groups in ICM.
+
OKTA integrates various applications into its service, and you simply deploy these pre-integrated applications to your users as necessary. For example, OKTA uses the SCIM application to provision users or user groups in ICI.
  
−
To provision or deprovision ICM users, the OKTA Administrator first needs to create and configure an application which supports the SCIM protocol. 
+
To provision or deprovision ICI users, the OKTA Administrator first needs to create and configure an application which supports the SCIM protocol. 
−
<div class="note-box">'''Note: '''ICM only supports SCIM 2.0 version.</div>  
+
<div class="note-box">'''Note: '''ICI only supports SCIM 2.0 version.</div>  
 
&nbsp;
 
&nbsp;
 
<div class="image-green-border">[[File:7.10 SCIM 1.png|720px|7.10 SCIM 1.png]]</div>  
 
<div class="image-green-border">[[File:7.10 SCIM 1.png|720px|7.10 SCIM 1.png]]</div>  
−
=== &nbsp; ===
 
−
 
−
 
−
=== &nbsp; ===
 
−
 
 
=== Configuring the SCIM Application ===
 
=== Configuring the SCIM Application ===
  
Line 24: Line 19:
 
<div class="image-green-border">[[File:7.10 SCIM 3.png|720px|7.10 SCIM 3.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">3. '''Click '''''Add Application''.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.10 SCIM 4.png|720px|7.10 SCIM 4.png]]</div>  
 
<div class="image-green-border">[[File:7.10 SCIM 3.png|720px|7.10 SCIM 3.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">3. '''Click '''''Add Application''.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.10 SCIM 4.png|720px|7.10 SCIM 4.png]]</div>  
 
4. '''Enter '''''scim ''in the search field to search applications that are supporting ''SCIM''.
 
4. '''Enter '''''scim ''in the search field to search applications that are supporting ''SCIM''.
−
<div class="image-green-border">[[File:7.10 SCIM 5.png|720px|7.10 SCIM 5.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note:''' ICM supports the ''SCIM 2.0 App (Header Auth) ''version to provision and deprovision users through OKTA.</div>  
+
<div class="image-green-border">[[File:7.10 SCIM 5.png|720px|7.10 SCIM 5.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note:''' ICI supports the ''SCIM 2.0 App (Header Auth) ''version to provision and deprovision users through OKTA.</div>  
−
5. '''Select''' the application created by the OKTA Administrator using ''SCIM 2.0 App (Header Auth)'' for SCIM protocol. &nbsp;For example, ''SCIM to ICM ''application (as shown in the screenshot below):
+
5. '''Select''' the application created by the OKTA Administrator using ''SCIM 2.0 App (Header Auth)'' for SCIM protocol. &nbsp;For example, ''SCIM to ICI ''application (as shown in the screenshot below):
 
<div class="image-green-border">[[File:7.10 SCIM 6.png|720px|7.10 SCIM 6.png]]</div>  
 
<div class="image-green-border">[[File:7.10 SCIM 6.png|720px|7.10 SCIM 6.png]]</div>  
−
To configure SCIM to ICM application, the OKTA Administrator performs the following steps:
+
To configure SCIM to ICI application, the OKTA Administrator performs the following steps:
  
 
1. '''Click '''the ''Provisioning'' tab.
 
1. '''Click '''the ''Provisioning'' tab.
Line 33: Line 28:
 
2. '''Click '''the ''Integration'' tab.
 
2. '''Click '''the ''Integration'' tab.
  
−
3. '''Enter''' the ''Base URL ''and ''API Token'' as provided by ICM Administrator.
+
3. '''Enter''' the ''Base URL ''and ''API Token'' as provided by ICI Administrator.
 
<div class="note-box">'''Note: '''Ensure that the ''Enable API Integration'' box is checked.</div>  
 
<div class="note-box">'''Note: '''Ensure that the ''Enable API Integration'' box is checked.</div>  
 
&nbsp;
 
&nbsp;
 
<div class="image-green-border">[[File:7.10 SCIM 7.png|720px|7.10 SCIM 7.png]]</div>  
 
<div class="image-green-border">[[File:7.10 SCIM 7.png|720px|7.10 SCIM 7.png]]</div>  
−
4. '''Click''' the ''Test API Credentials'' button to validate the credentials (ICM ''Base URL ''and ''API Token''). A validation message will be displayed on entering incorrect credentials indicating that an authentication error has occurred.&nbsp;
+
4. '''Click''' the ''Test API Credentials'' button to validate the credentials (ICI ''Base URL ''and ''API Token''). A validation message will be displayed on entering incorrect credentials indicating that an authentication error has occurred.&nbsp;
 
<div class="image-green-border">[[File:7.10 SCIM 8.png|720px|7.10 SCIM 8.png]]</div>  
 
<div class="image-green-border">[[File:7.10 SCIM 8.png|720px|7.10 SCIM 8.png]]</div>  
−
To allow Provisioning of SCIM application i.e. from OKTA to SCIM, the Administrator enables functionalities such as ''Create Users'', ''Update User Attributes'', and ''Deactivate Users''. After enabling the functionalities, you can provision/deprovision users in ICM from OKTA using the SCIM protocol (for example, ''SCIM to ICM'' application as mentioned in Step 5).
+
To allow Provisioning of SCIM application i.e. from OKTA to SCIM, the Administrator enables functionalities such as ''Create Users'', ''Update User Attributes'', and ''Deactivate Users''. After enabling the functionalities, you can provision/deprovision users in ICI from OKTA using the SCIM protocol (for example, ''SCIM to ICI'' application as mentioned in Step 5).
  
 
&nbsp;
 
&nbsp;
Line 55: Line 50:
 
4. '''Enter '''details such as ''First name'', ''Last name'', ''Username'' and ''Primary email''. For example, add user - Michael Smith.
 
4. '''Enter '''details such as ''First name'', ''Last name'', ''Username'' and ''Primary email''. For example, add user - Michael Smith.
 
<div class="image-green-border">[[File:7.10 SCIM 11.png|720px|7.10 SCIM 11.png]]</div>  
 
<div class="image-green-border">[[File:7.10 SCIM 11.png|720px|7.10 SCIM 11.png]]</div>  
−
5. '''Click '''''Save''. The user ''Michael Smith'' is added to the application ''SCIM to ICM''.
+
5. '''Click '''''Save''. The user ''Michael Smith'' is added to the application ''SCIM to ICI''.
 
<div class="image-green-border">[[File:7.10 SCIM 12.png|720px|7.10 SCIM 12.png]]</div>  
 
<div class="image-green-border">[[File:7.10 SCIM 12.png|720px|7.10 SCIM 12.png]]</div>  
−
6. The user ''Michael Smith ''can now be provisioned to ICM using ''Assignments'' tab.
+
6. The user ''Michael Smith ''can now be provisioned to ICI using ''Assignments'' tab.
  
 
&nbsp;
 
&nbsp;
Line 63: Line 58:
 
== Provisioning users ==
 
== Provisioning users ==
  
−
You can provision users by adding users individually or by user group in ICM:
+
You can provision users by adding users individually or by user group in ICI:
  
 
1. '''Click''' the''Assignments'' tab.
 
1. '''Click''' the''Assignments'' tab.
Line 70: Line 65:
  
 
3. '''Select''' ''Assign to People'' to select an individual user or select ''Assign to Groups ''to select a user group.
 
3. '''Select''' ''Assign to People'' to select an individual user or select ''Assign to Groups ''to select a user group.
−
<div class="note-box">'''Note: '''A user needs to be added to the OKTA global directory to be provisioned in ICM.</div>  
+
<div class="note-box">'''Note: '''A user needs to be added to the OKTA global directory to be provisioned in ICI.</div>  
 
&nbsp;
 
&nbsp;
 
<div class="image-green-border">[[File:7.10 SCIM 13.png|720px|7.10 SCIM 13.png]]</div>  
 
<div class="image-green-border">[[File:7.10 SCIM 13.png|720px|7.10 SCIM 13.png]]</div>  
Line 77: Line 72:
 
=== Provisioning users using assignment ===
 
=== Provisioning users using assignment ===
  
−
To add a user to ''SCIM to ICM'' Assignments:
+
To add a user to ''SCIM to ICI'' Assignments:
  
 
1. '''Click '''the ''Assignments ''tab in the ''Applications'' menu.
 
1. '''Click '''the ''Assignments ''tab in the ''Applications'' menu.
Line 83: Line 78:
 
2. '''Click '''the ''Assign'' drop-down.
 
2. '''Click '''the ''Assign'' drop-down.
 
<div class="image-green-border">[[File:7.10 SCIM 14.png|720px|7.10 SCIM 14.png]]</div>  
 
<div class="image-green-border">[[File:7.10 SCIM 14.png|720px|7.10 SCIM 14.png]]</div>  
−
3. '''Click''' ''Assign to People''. The ''Assign SCIM to ICM to People'' window opens.
+
3. '''Click''' ''Assign to People''. The ''Assign SCIM to ICI to People'' window opens.
  
 
4. '''Search '''for a user in the search tab. For example, ''Morita Akemi''.
 
4. '''Search '''for a user in the search tab. For example, ''Morita Akemi''.
  
 
5. '''Click '''''Assign''.
 
5. '''Click '''''Assign''.
−
<div class="note-box">'''Note: '''As per the ICM SCIM implementation, when a user gets provisioned, ICM first verifies if the user is already present or not.</div>  
+
<div class="note-box">'''Note: '''As per the ICI SCIM implementation, when a user gets provisioned, ICI first verifies if the user is already present or not.</div>  
−
*If the user is not present, ICM creates a new user.  
+
*If the user is not present, ICI creates a new user.  
−
*If the user is present, but in the deprovisioned state, then ICM reprovisions the user only if the ''External identifier'' value in ICM is matching with the value of SCIM ''External identifier''.  
+
*If the user is present, but in the deprovisioned state, then ICI reprovisions the user only if the ''External identifier'' value in ICI is matching with the value of SCIM ''External identifier''.  
 
<div class="image-green-border">[[File:7.10 SCIM 42.png|720px|7.10 SCIM 42.png]]</div>  
 
<div class="image-green-border">[[File:7.10 SCIM 42.png|720px|7.10 SCIM 42.png]]</div>  
 
6. '''Click '''''Save'' ''and'' ''Go Back''.
 
6. '''Click '''''Save'' ''and'' ''Go Back''.
Line 96: Line 91:
 
7. '''Click '''''Done.''
 
7. '''Click '''''Done.''
 
<div class="image-green-border">[[File:7.10 SCIM 17.png|720px|7.10 SCIM 17.png]]</div>  
 
<div class="image-green-border">[[File:7.10 SCIM 17.png|720px|7.10 SCIM 17.png]]</div>  
−
The user is assigned and provisioned in ICM.
+
The user is assigned and provisioned in ICI.
 
<div class="image-green-border">[[File:7.10 SCIM 18.png|720px|7.10 SCIM 18.png]]</div>  
 
<div class="image-green-border">[[File:7.10 SCIM 18.png|720px|7.10 SCIM 18.png]]</div>  
 
&nbsp;
 
&nbsp;
Line 102: Line 97:
 
=== Provisioning users using group assignment ===
 
=== Provisioning users using group assignment ===
  
−
Group assignment in SCIM is a convenient way to get multiple assignments. Using SCIM Group, users are provisioned to ICM in one go. You can create User Groups in ICM using Add Group functionality of SCIM.
+
Group assignment in SCIM is a convenient way to get multiple assignments. Using SCIM Group, users are provisioned to ICI in one go. You can create User Groups in ICI using Add Group functionality of SCIM.
  
−
You can provision multiple users in ICM by using a group assignment provided they are already assigned and displayed in the ''Assignments'' tab.&nbsp;&nbsp;
+
You can provision multiple users in ICI by using a group assignment provided they are already assigned and displayed in the ''Assignments'' tab.&nbsp;&nbsp;
 +
<div class="note-box">'''Note:''' Do not use the same group for ''Assignment'' and ''Push Groups''.</div>
 +
To add already assigned members to a group ''SCIM to ICI group'':
  
−
'''Note:''' Do not use the same group for ''Assignment'' and ''Push Groups''.
+
1. '''Click '''''SCIM to ICI group''.
  
−
To add already assigned members to a group ''SCIM to ICM group'':
+
2. '''Click '''''Manage People'''''.'''
 +
<div class="image-green-border">[[File:7.10 SCIM 19.png|720px|7.10 SCIM 19.png]]</div>
 +
3. '''Search '''a user'''. '''For example''', '''Michael Smith should already be provisioned in ICI through an individual or group assignment.
 +
<div class="image-green-border">[[File:7.10 SCIM 20.png|720px|7.10 SCIM 20.png]]</div>
 +
4. '''Click '''the ''Add'' icon.
  
−
#'''Click '''''SCIM to ICM group''.  
+
5. '''Click '''''Save. ''The user ''Michael Smith'' is added to the group ''SCIM to ICI group''.
−
#'''Click '''''Manage People'''''.'''
+
  
 
&nbsp;
 
&nbsp;
  
−
#'''Search '''a user'''. '''For example''', '''Michael Smith should already be provisioned in ICM through an individual or group assignment.
+
=== Mapping ICI attributes with SCIM attributes ===
  
−
&nbsp;
+
To map ICI attributes with SCIM attributes, you must create the ''Client App Entity Mapping''.
  
−
#'''Click '''the ''Add'' icon.
+
==== Client App Entity Mapping ====
−
#'''Click '''''Save. ''The user ''Michael Smith'' is added to the group ''SCIM to ICM group''.
+
  
−
&nbsp;
+
1. '''Click''' the ''Configuration'' tile. The ''Configuration'' page opens.
  
−
&nbsp;
+
2. '''Click''' the ''Masterdata ''tile''. ''The ''Masterdata'' page opens.
  
−
=== Mapping ICM attributes with SCIM attributes ===
+
3. '''Click''' the ''Create Masterdata ''tile''. ''The ''Create Masterdata'' page opens.
−
 
+
−
To map ICM attributes with SCIM attributes, you must create the ''Client App Entity Mapping''.
+
−
 
+
−
==== Client App Entity Mapping ====
+
−
 
+
−
#'''Click''' the ''Configuration'' tile. The ''Configuration'' page opens.
+
−
#'''Click''' the ''Masterdata ''tile''. ''The ''Masterdata'' page opens.
+
−
#'''Click''' the ''Create Masterdata ''tile''. ''The ''Create Masterdata'' page opens.  
+
  
 
The ''Create Masterdata'' page contains the following tabs:
 
The ''Create Masterdata'' page contains the following tabs:
−
<ol style="list-style-type:lower-alpha;">
 
−
<li>''Masterdata Details''</li>
 
−
<li>''Attributes''</li>
 
−
</ol>
 
  
−
&nbsp;
+
''a. Masterdata Details''
  
−
'''Masterdata Details'''
+
''b. Attributes''
 +
<div class="image-green-border">''[[File:7.10 SCIM 21.png|720px|7.10 SCIM 21.png]]''</div>
 +
a. '''Masterdata Details'''
  
−
&nbsp;
+
1. '''Select&nbsp;'''the ''Category'' from the drop-down. For example, ''Default''.
  
−
#'''Select&nbsp;'''the ''Category'' from the drop-down. For example, ''Default''.
+
2. '''Select'''&nbsp;the Masterdata Contract Type.
−
#'''Select'''&nbsp;the Masterdata Contract Type.  
+
<div class="note-box">'''Note: '''In order to map the SCIM attribute name with ICI attribute name''', '''you must select&nbsp;''Client App Entity Mapping ''from the drop-down.</div>
−
 
+
3. '''Click&nbsp;'''''Next. ''The ''Attributes''&nbsp;page opens.
−
'''Note: '''In order to map the SCIM attribute name with ICM attribute name''', '''you must select&nbsp;''Client App Entity Mapping ''from the drop-down.
+
−
 
+
−
&nbsp;
+
−
 
+
−
&nbsp;
+
−
 
+
−
#'''Click&nbsp;'''''Next. ''The ''Attributes''&nbsp;page opens.  
+
−
 
+
−
'''Attributes'''
+
−
 
+
−
&nbsp;
+
−
 
+
−
&nbsp;
+
−
 
+
−
&nbsp;
+
  
 +
b. '''Attributes'''
 +
<div class="image-green-border">[[File:7.10 SCIM 22.png|720px|7.10 SCIM 22.png]]</div>
 
Provide relevant attribute values in the respective fields:
 
Provide relevant attribute values in the respective fields:
−
 
+
<div class="image-green-border">[[File:7.10 SCIM 23.PNG|720px|7.10 SCIM 23.PNG]]</div>
−
&nbsp;
+
−
 
+
 
'''Note''':
 
'''Note''':
  
−
*It’s mandatory to create the Client App Entity Mapping for the attribute ''ExternalUPN.''  
+
*It is mandatory to create the Client App Entity Mapping for the attribute ''ExternalUPN.''  
−
*Repeat the steps under Client App Entity Mapping to map other attributes such as ''Phone Number'' from SCIM to ICM.
+
*Repeat the steps under Client App Entity Mapping to map other attributes such as ''Phone Number'' from SCIM to ICI.  
−
*To map attributes such as ''Organization Unit'' ''Id ''and ''Organization Path Id'', you must create the masterdata ''Org Path Mapping, ''and map with the Client Attribute Name specified in the ''Client App Entity Mapping''. The ''Org Path Mapping ''masterdata is used to map the Client Attribute Name with a particular Organization using the Organization Unit Path value.  
+
  
 
The Client App Entity Mapping created is displayed as shown in the screenshot below:
 
The Client App Entity Mapping created is displayed as shown in the screenshot below:
−
 
+
<div class="image-green-border">[[File:7.10 SCIM 24.PNG|720px|7.10 SCIM 24.PNG]]</div>
 +
The value of the SCIM attribute name (for example, ''userName'') is mapped with ICI attribute name (for example, ''ExternalUPN'') as shown in the screenshot below:&nbsp;
 +
<div class="image-green-border">[[File:7.10 SCIM 25.png|720px|7.10 SCIM 25.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">Note: To map attributes such as ''Organization Unit Id, Organization Path'' Id or ''SharedOrgPathId'', apart from the ''Client App Entity Mapping'' masterdata, you must create the ''Org Path Mapping ''masterdata, and map with the ''Client Attribute Name'' specified in ''Client App Entity Mapping''. The ''Org Path Mapping'' masterdata is used to map the value of the ''Client Attribute Name'' with the respective Organization using the ''Organization Unit Path'' value.</div>
 
&nbsp;
 
&nbsp;
−
 
+
<div class="image-green-border">[[File:7.10 SCIM 45.PNG|720px|7.10 SCIM 45.PNG]]</div>
−
&nbsp;
+
In this example, the value of ''Client Attribute Name'' as shown in the above screenshot is mapped to the ''Org Path Mapping'' masterdata.
−
 
+
<div class="image-green-border">[[File:7.10 SCIM 46.png|720px|7.10 SCIM 46.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">In the above screenshot, name (for example, ''north'') is the value of ''Client Attribute Name'' (for example, ''bCGHomeOfficeCode'') in ''Client App Entity Mapping'' and ''Organization Unit Path'' is the org path.</div> <div class="image-green-border">
−
&nbsp;
+
Using the ''Client App Entity Mapping'' for attributes such as ''OrganizationUnitId, OrgPathId'' or ''SharedOrgPathId'', the ''Org Path Mapping ''will be used to map the respective Org of a user.
−
 
+
</div>
−
The value of the SCIM attribute name is automatically updated in ICM as shown in the screenshot below:&nbsp;
+
−
 
+
−
&nbsp;
+
−
 
+
−
&nbsp;
+
−
 
+
 
&nbsp;
 
&nbsp;
  
 
== Deprovisioning users ==
 
== Deprovisioning users ==
  
−
You can deprovision users in ICM using the ''Assignments'' tab.
+
You can deprovision users in ICI using the ''Assignments'' tab.
  
 
=== Deprovisioning user from assignment ===
 
=== Deprovisioning user from assignment ===
Line 202: Line 171:
  
 
To deprovision an assigned user from SCIM:
 
To deprovision an assigned user from SCIM:
−
 
+
<div class="image-green-border">1. '''Click''' the&nbsp;[[File:7.10 SCIM 44.png|RTENOTITLE]]&nbsp;icon to unassign a user from OKTA. The ''Unassign User'' window opens.</div>
−
#'''Click''' the &nbsp;icon to unassign a user from OKTA. The ''Unassign User'' window opens.  
+
2. '''Select''' the user to be unassigned from the displayed records. For example, ''Michael Smith''.
−
#'''Select''' the user to be unassigned from the displayed records. For example, ''Michael Smith''.  
+
<div class="image-green-border">[[File:7.10 SCIM 26.png|720px|7.10 SCIM 26.png]]</div>
−
 
+
3. '''Click '''''OK''.
 +
<div class="image-green-border">[[File:7.10 SCIM 27.png|720px|7.10 SCIM 27.png]]</div>
 +
The user ''Michael Smith ''is unassigned from ''SCIM to ICI'' and subsequently deprovisioned from ICI.
 +
<div class="image-green-border">[[File:7.10 SCIM 28.png|720px|7.10 SCIM 28.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note:''' You can reprovision the user only in ICI only if the ''External identifier'' value in ICI is matching with the value of SCIM ''External identifier''.</div>
 
&nbsp;
 
&nbsp;
  
−
#'''Click '''''OK''.
+
== Creating User Groups in ICI using SCIM ==
  
−
&nbsp;
+
To create user groups in ICI using SCIM, you must create the ''SCIM Groups Mapping&nbsp;''masterdata.
  
−
&nbsp;
+
The ''SCIM Groups Mapping'' masterdata is created to define the mapping before pushing the group from SCIM to ICI, for example, to push the Group ''SCIM Admins'' from SCIM to ICI as ''Local Admins''. If the mapping is not present, the Group ''SCIM Admins'' will be created as Group ''SCIM Admins'' in ICI, and a masterdata record will also be created in ''SCIM Groups Mapping'' masterdata if the masterdata Contract Type is available.
 +
<div class="note-box">'''Note: '''The ''SCIM Groups Mapping'' masterdata is optional.</div>
 +
==== SCIM Groups Mapping ====
  
−
&nbsp;
+
1. '''Click''' the ''Configuration'' tile. The ''Configuration'' page opens.
  
−
The user ''Michael Smith ''is unassigned from ''SCIM to ICM'' and subsequently deprovisioned from ICM.
+
2. '''Click''' the ''Masterdata ''tile''. ''The ''Masterdata'' page opens.
  
−
&nbsp;
+
3. '''Click''' the ''Create Masterdata ''tile''. ''The ''Create Masterdata'' page opens.
−
 
+
−
'''Note:''' You can reprovision the user only in ICM only if the ''External identifier'' value in ICM is matching with the value of SCIM ''External identifier''.
+
−
 
+
−
&nbsp;
+
−
 
+
−
&nbsp;
+
−
 
+
−
&nbsp;
+
−
 
+
−
== Creating User Groups in ICM using SCIM ==
+
−
 
+
−
To create user groups in ICM using SCIM, you must create the masterdata ''SCIM Groups Mapping''.
+
−
 
+
−
The ''SCIM Groups Mapping'' masterdata is created to define the mapping before enabling the group Push from SCIM to ICM, for example, to push the Group ''SCIM Admins'' from SCIM to ICM as ''Local Admins''.&nbsp; If the mapping is not present, the Group ''SCIM Admins'' will be created as Group ''SCIM Admins'' in ICM, and a masterdata record will also be created in ''SCIM Groups Mapping'' masterdata if the masterdata is available.
+
−
 
+
−
'''Note: '''The ''SCIM Groups Mapping'' masterdata is optional.
+
−
 
+
−
==== SCIM Groups Mapping ====
+
−
 
+
−
#'''Click''' the ''Configuration'' tile. The ''Configuration'' page opens.
+
−
#'''Click''' the ''Masterdata ''tile''. ''The ''Masterdata'' page opens.
+
−
#'''Click''' the ''Create Masterdata ''tile''. ''The ''Create Masterdata'' page opens.  
+
  
 
The ''Create Masterdata'' page contains the following tabs:
 
The ''Create Masterdata'' page contains the following tabs:
−
<ol style="list-style-type:lower-alpha;">
 
−
<li>''Masterdata Details''</li>
 
−
<li>''Attributes''</li>
 
−
</ol>
 
  
−
&nbsp;
+
''a. Masterdata Details''
  
−
'''Masterdata Details'''
+
''b. Attributes''
 +
<div class="image-green-border">[[File:7.10 SCIM 29.png|720px|7.10 SCIM 29.png]]</div>
 +
a. '''Masterdata Details'''
  
−
&nbsp;
+
1. '''Select&nbsp;'''the ''Category'' from the drop-down. For example, ''Default''.
  
−
#'''Select&nbsp;'''the ''Category'' from the drop-down. For example, ''Default''.
+
2. '''Select'''&nbsp;the Masterdata Contract Type.
−
#'''Select'''&nbsp;the Masterdata Contract Type.  
+
<div class="note-box">'''Note: '''In order to create user groups in ICI using SCIM''', '''you must select&nbsp;''SCIM Groups'' ''Mapping ''from the drop-down.</div>
−
 
+
3. '''Click&nbsp;'''''Next. ''The ''Attributes''&nbsp;page opens.
−
'''Note: '''In order to create user groups in ICM using SCIM''', '''you must select&nbsp;''SCIM Groups'' ''Mapping ''from the drop-down.
+
−
 
+
−
&nbsp;
+
−
 
+
−
&nbsp;
+
−
 
+
−
#'''Click&nbsp;'''''Next. ''The ''Attributes''&nbsp;page opens.  
+
−
 
+
−
'''Attributes'''
+
−
 
+
−
&nbsp;
+
−
 
+
−
&nbsp;
+
  
−
*'''Enter''' the masterdata ''Name'' (such as SCIM to ICM group) and the ''SCIM Group Name'' (such as SCIM to ICM group).  
+
b.&nbsp;'''Attributes'''
 +
<div class="image-green-border">[[File:7.10 SCIM 30.png|720px|7.10 SCIM 30.png]]</div>
 +
*'''Enter''' the masterdata ''Name'' (such as SCIM to ICI group) and the ''SCIM Group Name'' (such as SCIM to ICI group).  
 
*'''Click''' ''Save.''  
 
*'''Click''' ''Save.''  
  
 
The SCIM Groups Mapping created is displayed as shown in the screenshot below:
 
The SCIM Groups Mapping created is displayed as shown in the screenshot below:
 +
<div class="image-green-border">[[File:7.10 SCIM 31.png|720px|7.10 SCIM 31.png]]</div>
 +
To create ''User Group'' using SCIM:
  
−
&nbsp;
+
1. '''Click '''the ''Users ''tab on the OKTA Dashboard.
  
−
&nbsp;
+
2. '''Select '''''Groups'' from the drop-down menu. The ''Groups'' page opens.
  
−
&nbsp;
+
3. '''Click '''''Add Group.''
  
−
To create ''User Group'' using SCIM:
+
4. '''Enter '''''Name''. For example, ''SCIM to ICI group''.
−
 
+
<div class="image-green-border">[[File:7.10 SCIM 32.png|720px|7.10 SCIM 32.png]]</div>
−
#'''Click '''the ''Users ''tab on the OKTA Dashboard.  
+
5. '''Click '''''Add Group''. The group is added in SCIM.
−
#'''Select '''''Groups'' from the drop-down menu. The ''Groups'' page opens.
+
−
#'''Click '''''Add Group.''
+
−
#'''Enter '''''Name''. For example, ''SCIM to ICM group''.  
+
−
 
+
−
&nbsp;
+
−
 
+
−
#'''Click '''''Add Group''. The group is added in SCIM.  
+
  
 
'''Push Groups:'''
 
'''Push Groups:'''
  
−
Push Group is used to create User Groups in ICM. You can push groups with members, but the member should have already been provisioned in ICM using ''Assignment'' either individually or group assignment.
+
Push Group is used to create User Groups in ICI. You can push groups with members, but the member should have already been provisioned in ICI using ''Assignment'' either individually or group assignment.
  
−
&nbsp;
+
6.&nbsp;'''Click '''the ''Push Groups ''tab''.''
  
−
&nbsp;
+
7.&nbsp;'''Click '''the ''Push Groups ''drop-down''.''
 +
<div class="image-green-border">[[File:7.10 SCIM 33.png|720px|7.10 SCIM 33.png]]</div>
 +
8. '''Search '''a group using the search field''.'' For example,''SCIM to ICI group.''
  
−
#'''Click '''the ''Push Groups ''tab''.''  
+
9. '''Select '''the desired group from the displayed records.
−
#'''Click '''the ''Push Groups ''drop-down''.''
+
  
 +
10. '''Click '''''Save''. The ''SCIM to ICI'' group is now pushed to ICI.
 +
<div class="image-green-border">[[File:7.10 SCIM 34.png|720px|7.10 SCIM 34.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note:''' The difference between ''Groups'' and ''Push Groups ''is that ''Groups'' need to be assigned using ''Assignments,'' whereas ''Push Groups'' is only meant to push users (part of the selected group) to be provisioned in ICI in one go. These groups are not assigned in the ''Assignments'' tab.</div>
 
&nbsp;
 
&nbsp;
−
 
+
<div class="image-green-border">[[File:7.10 SCIM 35.png|720px|7.10 SCIM 35.png]]</div>
−
#'''Search '''a group using the search field''.'' For example,''SCIM to ICM group.''  
+
11. The members of the group ''SCIM to ICI group'' are pushed to ICI. For example, the user of the group ''SCIM to ICI group'' ''Michael Smith'' is pushed to ICI.
−
#'''Select '''the desired group from the displayed records.  
+
<div class="note-box">'''Note: '''Users need to be assigned through assignment to be pushed by ''Push Groups''.</div>
−
#'''Click '''''Save''. The ''SCIM to ICM'' group is now pushed to ICM.
+
−
 
+
 
&nbsp;
 
&nbsp;
 +
<div class="image-green-border">[[File:7.10 SCIM 36.png|720px|7.10 SCIM 36.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.10 SCIM 37.png|720px|7.10 SCIM 37.png]]</div>
 +
== Managing ICI User Group members using SCIM ==
  
−
'''Note:''' The difference between ''Groups'' and ''Push Groups ''is that ''Groups'' need to be assigned using ''Assignments,'' whereas ''Push Groups'' is only meant to push users (part of the selected group) to be provisioned in ICM in one go. These groups are not assigned in the ''Assignments'' tab.
+
To deprovision a user using SCIM, you first need to remove the user from the ''Push Groups. ''For example, let us remove the user ''Michael Smith'' from Push Groups''SCIM to ICI group''.
  
−
&nbsp;
+
1. Go to the ''Push Groups'' tab.
  
−
#The members of the group ''SCIM to ICM group'' are pushed to ICM. For example, the user of the group ''SCIM to ICM group'' ''Michael Smith'' is pushed to ICM.
+
2. '''Click '''the ''Push Groups''. For example, ''SCIM to ICI group''.
−
 
+
<div class="image-green-border">[[File:7.10 SCIM 38.png|720px|7.10 SCIM 38.png]]</div>
−
'''Note: '''Users need to be assigned through assignment to be pushed by ''Push Groups''.
+
3. '''Click '''''Manage People''. The ''SCIM to ICI group'' opens.
−
 
+
<div class="image-green-border">[[File:7.10 SCIM 39.png|720px|7.10 SCIM 39.png]]</div>
−
&nbsp;
+
4. '''Click '''the remove icon for the user to be removed. For example, ''Michael Smith''.
−
 
+
<div class="image-green-border">[[File:7.10 SCIM 40.png|720px|7.10 SCIM 40.png]]</div>
−
&nbsp;
+
5. '''Click '''''Save''. The user is removed from the ''Push Group'' - ''SCIM to ICI group'' and consequently gets deprovisioned from the ''User Groups ''in ICI.
−
 
+
<div class="image-green-border">[[File:7.12 SCIM Users.PNG|720px|7.12 SCIM Users.PNG]]</div>
−
&nbsp;
+
−
 
+
−
&nbsp;
+
−
 
+
−
&nbsp;
+
−
 
+
−
&nbsp;
+
−
 
+
−
== Managing ICM User Group members using SCIM ==
+
−
 
+
−
To deprovision a user using SCIM, you first need to remove the user from the ''Push Groups. ''For example, let us remove the user ''Michael Smith'' from Push Groups''SCIM to ICM group''.
+
−
 
+
−
#Go to the ''Push Groups'' tab.  
+
−
#'''Click '''the ''Push Groups''. For example, ''SCIM to ICM group''.  
+
−
 
+
−
&nbsp;
+
−
 
+
−
#'''Click '''''Manage People''. The ''SCIM to ICM group'' opens.  
+
−
 
+
−
&nbsp;
+
−
 
+
−
&nbsp;
+
−
 
+
−
&nbsp;
+
−
 
+
−
#'''Click '''the remove icon for the user to be removed. For example, ''Michael Smith''.  
+
−
 
+
−
&nbsp;
+
−
 
+
−
#'''Click '''''Save''. The user is removed from the ''Push Group'' - ''SCIM to ICM group'' and consequently gets deprovisioned from the ''User Groups ''in ICM.  
+
−
 
+
−
&nbsp;
+

Latest revision as of 12:36, 12 September 2020

System for Cross Domain Identity Management (SCIM)

ICI is now providing support for System for Cross-domain Identity Management (SCIM), which is an open standard protocol to automate the provisioning and deprovisioning of users. This framework allows exchange of user identity and user group information between identity providers (such as OKTA) and service providers (such as ICI – SaaS-based application). As a single system is used to manage permissions and groups, and data is transferred automatically, the risk of error is considerably reduced. This makes user management simpler and easier for customers. 

OKTA integrates various applications into its service, and you simply deploy these pre-integrated applications to your users as necessary. For example, OKTA uses the SCIM application to provision users or user groups in ICI.

To provision or deprovision ICI users, the OKTA Administrator first needs to create and configure an application which supports the SCIM protocol. 

Note: ICI only supports SCIM 2.0 version.

 

7.10 SCIM 1.png

Configuring the SCIM Application

The OKTA Administrator uses the OKTA Dashboard to configure the SCIM application.

7.10 SCIM 2.png

1. Click the Applications tab.

2. Select Applications from the drop-down. The Applications page opens.

7.10 SCIM 3.png
 
3. Click Add Application.
 
7.10 SCIM 4.png

4. Enter scim in the search field to search applications that are supporting SCIM.

7.10 SCIM 5.png
 
Note: ICI supports the SCIM 2.0 App (Header Auth) version to provision and deprovision users through OKTA.

5. Select the application created by the OKTA Administrator using SCIM 2.0 App (Header Auth) for SCIM protocol.  For example, SCIM to ICI application (as shown in the screenshot below):

7.10 SCIM 6.png

To configure SCIM to ICI application, the OKTA Administrator performs the following steps:

1. Click the Provisioning tab.

2. Click the Integration tab.

3. Enter the Base URL and API Token as provided by ICI Administrator.

Note: Ensure that the Enable API Integration box is checked.

 

7.10 SCIM 7.png

4. Click the Test API Credentials button to validate the credentials (ICI Base URL and API Token). A validation message will be displayed on entering incorrect credentials indicating that an authentication error has occurred. 

7.10 SCIM 8.png

To allow Provisioning of SCIM application i.e. from OKTA to SCIM, the Administrator enables functionalities such as Create Users, Update User Attributes, and Deactivate Users. After enabling the functionalities, you can provision/deprovision users in ICI from OKTA using the SCIM protocol (for example, SCIM to ICI application as mentioned in Step 5).

 

Adding a user in OKTA

To add a user in OKTA:

1. Click Users menu on the Dashboard.

2. Click People.

7.10 SCIM 9.png

3. Click Add Person. The Add Person window opens.

7.10 SCIM 10.png

4. Enter details such as First name, Last name, Username and Primary email. For example, add user - Michael Smith.

7.10 SCIM 11.png

5. Click Save. The user Michael Smith is added to the application SCIM to ICI.

7.10 SCIM 12.png

6. The user Michael Smith can now be provisioned to ICI using Assignments tab.

 

Provisioning users

You can provision users by adding users individually or by user group in ICI:

1. Click theAssignments tab.

2. Click Assign drop-down.

3. Select Assign to People to select an individual user or select Assign to Groups to select a user group.

Note: A user needs to be added to the OKTA global directory to be provisioned in ICI.

 

7.10 SCIM 13.png

 

Provisioning users using assignment

To add a user to SCIM to ICI Assignments:

1. Click the Assignments tab in the Applications menu.

2. Click the Assign drop-down.

7.10 SCIM 14.png

3. Click Assign to People. The Assign SCIM to ICI to People window opens.

4. Search for a user in the search tab. For example, Morita Akemi.

5. Click Assign.

Note: As per the ICI SCIM implementation, when a user gets provisioned, ICI first verifies if the user is already present or not.
  • If the user is not present, ICI creates a new user.
  • If the user is present, but in the deprovisioned state, then ICI reprovisions the user only if the External identifier value in ICI is matching with the value of SCIM External identifier.
7.10 SCIM 42.png

6. Click Save and Go Back.

7.10 SCIM 16.png

7. Click Done.

7.10 SCIM 17.png

The user is assigned and provisioned in ICI.

7.10 SCIM 18.png

 

Provisioning users using group assignment

Group assignment in SCIM is a convenient way to get multiple assignments. Using SCIM Group, users are provisioned to ICI in one go. You can create User Groups in ICI using Add Group functionality of SCIM.

You can provision multiple users in ICI by using a group assignment provided they are already assigned and displayed in the Assignments tab.  

Note: Do not use the same group for Assignment and Push Groups.

To add already assigned members to a group SCIM to ICI group:

1. Click SCIM to ICI group.

2. Click Manage People.

7.10 SCIM 19.png

3. Search a user. For example, Michael Smith should already be provisioned in ICI through an individual or group assignment.

7.10 SCIM 20.png

4. Click the Add icon.

5. Click Save. The user Michael Smith is added to the group SCIM to ICI group.

 

Mapping ICI attributes with SCIM attributes

To map ICI attributes with SCIM attributes, you must create the Client App Entity Mapping.

Client App Entity Mapping

1. Click the Configuration tile. The Configuration page opens.

2. Click the Masterdata tile. The Masterdata page opens.

3. Click the Create Masterdata tile. The Create Masterdata page opens.

The Create Masterdata page contains the following tabs:

a. Masterdata Details

b. Attributes

7.10 SCIM 21.png

a. Masterdata Details

1. Select the Category from the drop-down. For example, Default.

2. Select the Masterdata Contract Type.

Note: In order to map the SCIM attribute name with ICI attribute name, you must select Client App Entity Mapping from the drop-down.

3. Click Next. The Attributes page opens.

b. Attributes

7.10 SCIM 22.png

Provide relevant attribute values in the respective fields:

7.10 SCIM 23.PNG

Note:

  • It is mandatory to create the Client App Entity Mapping for the attribute ExternalUPN.
  • Repeat the steps under Client App Entity Mapping to map other attributes such as Phone Number from SCIM to ICI.

The Client App Entity Mapping created is displayed as shown in the screenshot below:

7.10 SCIM 24.PNG

The value of the SCIM attribute name (for example, userName) is mapped with ICI attribute name (for example, ExternalUPN) as shown in the screenshot below: 

7.10 SCIM 25.png
 
Note: To map attributes such as Organization Unit Id, Organization Path Id or SharedOrgPathId, apart from the Client App Entity Mapping masterdata, you must create the Org Path Mapping masterdata, and map with the Client Attribute Name specified in Client App Entity Mapping. The Org Path Mapping masterdata is used to map the value of the Client Attribute Name with the respective Organization using the Organization Unit Path value.

 

7.10 SCIM 45.PNG

In this example, the value of Client Attribute Name as shown in the above screenshot is mapped to the Org Path Mapping masterdata.

7.10 SCIM 46.png
 
In the above screenshot, name (for example, north) is the value of Client Attribute Name (for example, bCGHomeOfficeCode) in Client App Entity Mapping and Organization Unit Path is the org path.

Using the Client App Entity Mapping for attributes such as OrganizationUnitId, OrgPathId or SharedOrgPathId, the Org Path Mapping will be used to map the respective Org of a user.

 

Deprovisioning users

You can deprovision users in ICI using the Assignments tab.

Deprovisioning user from assignment

You can deprovision user either individually or by removing the user from the group which was used as assignment.

To deprovision an assigned user from SCIM:

1. Click the RTENOTITLE icon to unassign a user from OKTA. The Unassign User window opens.

2. Select the user to be unassigned from the displayed records. For example, Michael Smith.

7.10 SCIM 26.png

3. Click OK.

7.10 SCIM 27.png

The user Michael Smith is unassigned from SCIM to ICI and subsequently deprovisioned from ICI.

7.10 SCIM 28.png
 
Note: You can reprovision the user only in ICI only if the External identifier value in ICI is matching with the value of SCIM External identifier.

 

Creating User Groups in ICI using SCIM

To create user groups in ICI using SCIM, you must create the SCIM Groups Mapping masterdata.

The SCIM Groups Mapping masterdata is created to define the mapping before pushing the group from SCIM to ICI, for example, to push the Group SCIM Admins from SCIM to ICI as Local Admins. If the mapping is not present, the Group SCIM Admins will be created as Group SCIM Admins in ICI, and a masterdata record will also be created in SCIM Groups Mapping masterdata if the masterdata Contract Type is available.

Note: The SCIM Groups Mapping masterdata is optional.

SCIM Groups Mapping

1. Click the Configuration tile. The Configuration page opens.

2. Click the Masterdata tile. The Masterdata page opens.

3. Click the Create Masterdata tile. The Create Masterdata page opens.

The Create Masterdata page contains the following tabs:

a. Masterdata Details

b. Attributes

7.10 SCIM 29.png

a. Masterdata Details

1. Select the Category from the drop-down. For example, Default.

2. Select the Masterdata Contract Type.

Note: In order to create user groups in ICI using SCIM, you must select SCIM Groups Mapping from the drop-down.

3. Click Next. The Attributes page opens.

b. Attributes

7.10 SCIM 30.png
  • Enter the masterdata Name (such as SCIM to ICI group) and the SCIM Group Name (such as SCIM to ICI group).
  • Click Save.

The SCIM Groups Mapping created is displayed as shown in the screenshot below:

7.10 SCIM 31.png

To create User Group using SCIM:

1. Click the Users tab on the OKTA Dashboard.

2. Select Groups from the drop-down menu. The Groups page opens.

3. Click Add Group.

4. Enter Name. For example, SCIM to ICI group.

7.10 SCIM 32.png

5. Click Add Group. The group is added in SCIM.

Push Groups:

Push Group is used to create User Groups in ICI. You can push groups with members, but the member should have already been provisioned in ICI using Assignment either individually or group assignment.

6. Click the Push Groups tab.

7. Click the Push Groups drop-down.

7.10 SCIM 33.png

8. Search a group using the search field. For example,SCIM to ICI group.

9. Select the desired group from the displayed records.

10. Click Save. The SCIM to ICI group is now pushed to ICI.

7.10 SCIM 34.png
 
Note: The difference between Groups and Push Groups is that Groups need to be assigned using Assignments, whereas Push Groups is only meant to push users (part of the selected group) to be provisioned in ICI in one go. These groups are not assigned in the Assignments tab.

 

7.10 SCIM 35.png

11. The members of the group SCIM to ICI group are pushed to ICI. For example, the user of the group SCIM to ICI group Michael Smith is pushed to ICI.

Note: Users need to be assigned through assignment to be pushed by Push Groups.

 

7.10 SCIM 36.png
 
7.10 SCIM 37.png

Managing ICI User Group members using SCIM

To deprovision a user using SCIM, you first need to remove the user from the Push Groups. For example, let us remove the user Michael Smith from Push GroupsSCIM to ICI group.

1. Go to the Push Groups tab.

2. Click the Push Groups. For example, SCIM to ICI group.

7.10 SCIM 38.png

3. Click Manage People. The SCIM to ICI group opens.

7.10 SCIM 39.png

4. Click the remove icon for the user to be removed. For example, Michael Smith.

7.10 SCIM 40.png

5. Click Save. The user is removed from the Push Group - SCIM to ICI group and consequently gets deprovisioned from the User Groups in ICI.

7.12 SCIM Users.PNG
Retrieved from "https://iciwikiapac.icertis.com:15443/ICIHelp7.15/index.php?title=System_for_Cross_Domain_Identity_Management&oldid=14841"