Setting up SCIM provisioning between OneLogin and IAM Identity Center
IAM Identity Center supports automatic provisioning (synchronization) of user and group information from OneLogin into IAM Identity Center using the System for Cross-domain Identity Management (SCIM) v2.0 protocol. For more information, see Using SAML and SCIM identity federation with external identity providers.
You configure this connection in OneLogin, using your SCIM endpoint for IAM Identity Center and a bearer token that is created automatically by IAM Identity Center. When you configure SCIM synchronization, you create a mapping of your user attributes in OneLogin to the named attributes in IAM Identity Center. This causes the expected attributes to match between IAM Identity Center and OneLogin.
The following steps walk you through how to enable automatic provisioning of users and groups from OneLogin to IAM Identity Center using the SCIM protocol.
Note
Before you begin deploying SCIM, we recommend that you first review the Considerations for using automatic provisioning.
Topics
Prerequisites
You will need the following before you can get started:
-
A OneLogin account. If you do not have an existing account, you may be able to obtain a free trial or developer account from the OneLogin website
. -
An IAM Identity Center-enabled account (free
). For more information, see Enable IAM Identity Center. -
A SAML connection from your OneLogin account to IAM Identity Center. For more information, see Enabling Single Sign-On Between OneLogin and AWS
on the AWS Partner Network Blog.
Step 1: Enable provisioning in IAM Identity Center
In this first step, you use the IAM Identity Center console to enable automatic provisioning.
To enable automatic provisioning in IAM Identity Center
-
After you have completed the prerequisites, open the IAM Identity Center console
. -
Choose Settings in the left navigation pane.
-
On the Settings page, locate the Automatic provisioning information box, and then choose Enable. This immediately enables automatic provisioning in IAM Identity Center and displays the necessary SCIM endpoint and access token information.
-
In the Inbound automatic provisioning dialog box, copy each of the values for the following options. You will need to paste these in later when you configure provisioning in your IdP.
-
SCIM endpoint - For example, https://scim.
us-east-2
.amazonaws.com/11111111111-2222-3333-4444-555555555555
/scim/v2 -
Access token - Choose Show token to copy the value.
Warning
This is the only time where you can obtain the SCIM endpoint and access token. Ensure you copy these values before moving forward. You will enter these values to configure automatic provisioning in your IdP later in this tutorial.
-
-
Choose Close.
You have now set up provisioning in the IAM Identity Center console. Now you need to do the remaining tasks using the OneLogin admin console as described in the following procedure.
Step 2: Configure provisioning in OneLogin
Use the following procedure in the OneLogin admin console to enable
integration between IAM Identity Center and the IAM Identity Center app. This procedure assumes you have already
configured the AWS Single Sign-On application in OneLogin for SAML
authentication. If you have not yet created this SAML connection, please do so before
proceeding and then return here to complete the SCIM provisioning process. For more
information about configuring SAML with OneLogin, see Enabling Single Sign-On Between OneLogin and AWS
To configure provisioning in OneLogin
-
Sign in to OneLogin, and then navigate to Applications > Applications.
-
On the Applications page, search for the application you created previously to form your SAML connection with IAM Identity Center. Choose it and then choose Configuration from the left navigation bar.
-
In the previous procedure, you copied the SCIM endpoint value in IAM Identity Center. Paste that value into the SCIM Base URL field in OneLogin. Also, in the previous procedure you copied the Access token value in IAM Identity Center. Paste that value into the SCIM Bearer Token field in OneLogin.
-
Next to API Connection, click Enable, and then click Save to complete the configuration.
-
In the left navigation bar, choose Provisioning.
-
Select the check boxes for Enable provisioning, Create user, Delete user, and Update user, and then choose Save.
-
In the left navigation bar, choose Users.
-
Click More Actions and choose Sync logins. You should receive the message Synchronizing users with AWS Single Sign-On.
-
Click More Actions again, and then choose Reapply entitlement mappings. You should receive the message Mappings are being reapplied.
-
At this point, the provisioning process should begin. To confirm this, navigate to Activity > Events, and monitor the progress. Successful provisioning events, as well as errors, should appear in the event stream.
-
To verify that your users and groups have all been successfully synchronized to IAM Identity Center, return to the IAM Identity Center console and choose Users. Your synchronized users from OneLogin appear on the Users page. You can also view your synchronized groups on the Groups page.
-
To synchronize user changes automatically to IAM Identity Center, navigate to the Provisioning page, locate the Require admin approval before this action is performed section, de-select Create User, Delete User, and/or Update User, and click Save.
(Optional) Step 3: Configure user attributes in OneLogin for access control in IAM Identity Center
This is an optional procedure for OneLogin if you choose to configure attributes you will use in IAM Identity Center to manage access to your AWS resources. The attributes that you define in OneLogin are passed in a SAML assertion to IAM Identity Center. You will then create a permission set in IAM Identity Center to manage access based on the attributes you passed from OneLogin.
Before you begin this procedure, you must first enable the Attributes for access control feature. For more information about how to do this, see Enable and configure attributes for access control.
To configure user attributes in OneLogin for access control in IAM Identity Center
-
Sign in to OneLogin, and then navigate to Applications > Applications.
-
On the Applications page, search for the application you created previously to form your SAML connection with IAM Identity Center. Choose it and then choose Parameters from the left navigation bar.
-
In the Required Parameters section, do the following for each attribute you want to use in IAM Identity Center:
-
Choose +.
-
In Field name, enter
https://aws.amazon.com/SAML/Attributes/AccessControl:
, and replaceAttributeName
AttributeName
with the name of the attribute you are expecting in IAM Identity Center. For example,https://aws.amazon.com/SAML/Attributes/AccessControl:Department
. -
Under Flags, check the box next to Include in SAML assertion, and choose Save.
-
In the Value field, use the drop-down list to choose the OneLogin user attributes. For example, Department.
-
-
Choose Save.
(Optional) Passing attributes for access control
You can optionally use the Attributes for access control feature in IAM Identity Center to pass an
Attribute
element with the Name
attribute set to
https://aws.amazon.com/SAML/Attributes/AccessControl:
.
This element allows you to pass attributes as session tags in the SAML assertion. For more
information about session tags, see Passing session tags in AWS STS in the IAM User Guide.{TagKey}
To pass attributes as session tags, include the AttributeValue
element that
specifies the value of the tag. For example, to pass the tag key-value pair
CostCenter = blue
, use the following attribute.
<saml:AttributeStatement> <saml:Attribute Name="https://aws.amazon.com/SAML/Attributes/AccessControl:CostCenter"> <saml:AttributeValue>blue </saml:AttributeValue> </saml:Attribute> </saml:AttributeStatement>
If you need to add multiple attributes, include a separate Attribute
element for each tag.
Troubleshooting
The following can help you troubleshoot some common issues you might encounter while setting up automatic provisioning with OneLogin.
Groups are not provisioned to IAM Identity Center
By default, groups may not be provisioned from OneLogin to IAM Identity Center.
Ensure that you’ve enabled group provisioning for your IAM Identity Center application in
OneLogin. To do this, sign in to the OneLogin admin
console, and check to make sure that the Include in User Provisioning
option is selected under the properties of the IAM Identity Center application (IAM Identity Center
application > Parameters > Groups). For more details on how to create groups
in OneLogin, including how to synchronize OneLogin roles as
groups in SCIM, please see the OneLogin website
Nothing is synchronized from OneLogin to IAM Identity Center, despite all settings being correct
In addition to the note above regarding admin approval, you will need to Reapply entitlement mappings for many configuration changes to take effect. This can be found in Applications > Applications > IAM Identity Center application > More Actions. You can see details and logs for most actions in OneLogin, including synchronization events, under Activity > Events.
I’ve deleted or disabled a group in OneLogin, but it still appears in IAM Identity Center
OneLogin currently does not support the SCIM DELETE operation for groups, which means that the group continues to exist in IAM Identity Center. You must therefore remove the group from IAM Identity Center directly to ensure that any corresponding permissions in IAM Identity Center for that group are removed.
I deleted a group in IAM Identity Center without first deleting it from OneLogin and now I’m having user/group sync issues
To remedy this situation, first ensure that you do not have any redundant group provisioning rules or configurations in OneLogin. For example, a group directly assigned to an application along with a rule that publishes to the same group. Next, delete any undesirable groups in IAM Identity Center. Finally, in OneLogin, Refresh the entitlements (IAM Identity Center App > Provisioning > Entitlements), and then Reapply entitlement mappings (IAM Identity Center App > More Actions). To avoid this issue in the future, first make the change to stop provisioning the group in OneLogin, then delete the group from IAM Identity Center.