> Security
> Identity Providers. The Identity Providers
List page appears.
Before you begin, you need to obtain the following from your Identity Provider:
● Client ID
● Client Secret
● Issuer URL
Additionally, you need the following values. You may be able to fetch these values from the Identity Provider once you have entered the Issuer URL:
● Authorization Endpoint
● Token Endpoint
● User Info Endpoint
● Revocation Endpoint
● JWKS URI
1. Click
> Security
> Identity Providers. The Identity Providers
List page appears.
2. Click Add and then select Generic (OIDC) from the drop-down list. The Add Identity Provider page appears.
3. Configure the Identity Provider Settings, as follows:
a. Enter a Name for your Identity Provider.
b. Enter the Client ID of the Identity Provider.
c. Enter the Client Secret. The client secret must match the client secret of the Identity Provider.
d. Select the Client Authentication Method from the drop-down list.
e. Enter the Issuer URL of the Identity Provider.
4. Click Fetch Configuration to obtain the fields for the OIDC Endpoints.
Note: If the Identity Provider uses User Info Endpoint, then select Require User Info Signature to require signature verification for responses to requests for user information. If this is enabled, then User Info responses must be signed.
5. Copy and paste into a text file the Redirect URI. You need to enter this value into your Identity Provider.
6. Enter the Requested Information from the Identity Provider.
a. Enter the Scopes. OIDC sends scopes to the Identity Provider to retrieve information.
Associated with each scope are claims. The Identity Provider returns multiple claims based on the requested scopes. The openid scope is mandatory to do authentication or verification.
b. Enter the ID Tokens Claims. Separate each value with a space. Leave this setting blank to omit the feature.
Id token claims requests from the Identity Provider define specific claims that can also be requested for inclusion in the returned id token. This can be used in addition to the requested scopes.
c. Enter the User Information Claims. Separate each value with a space. Leave this setting blank to omit the feature.
User information claims requests from the Identity Provider define specific claims that can also be requested for inclusion in the returned userinfo response. This can be used in addition to the requested scopes.
7. Enter the Max Authentication Age to set the allowed elapsed time, in seconds, since the last time a user was actively authenticated at the Identity Provider. For example, if you set a value of 300 seconds, if a user authenticated with the Identity Provider more than 300 seconds ago, they must re-authenticate. Leave this setting blank to omit this feature.
8. Enter the Auth Method Request values that are used by your Identity Provider. Separate each value with a space. Leave this setting blank to omit this feature.
9. Configure Branding as follows:
a. Enter the Login Button Text. This is the text that appears on the IDaaS log in page.
b. If your Identity Provider has a login button image, enter the URL in the Login Button Image field. The login button appears on the IDaaS log in page.
10. Configure User Management by mapping the users using one of the following options:
a. Select Create User to create the user whose information is returned from the Identity Provider if it does not already exist.
Attention: Create user allows anyone with access to your chosen Identity Provider to create a user in your IDaaS account. Depending on your IDaaS configuration, new users created by your IDP will be able to access all the resources controlled by your IDaaS account. This may be a concern if your Identity Provider has no limits on who can create an account or if it has a large userbase. Analyze the risks before enabling this option.
b. Select Update User (Authentication) to update the IDaaS user to match the Identity Provider during authentication.
If you select Update User (Authentication), the IDaaS system user attributes and any existing IDaaS custom user attributes can be set based on claim mappings. After user authentication, if the user exists in IDaaS, IDaaS compares the attributes of the existing user to the claims returned from the Identity Provider If they are different, the IDaaS user attributes are updated with the claim values.
c. Select Update User (Verification) to update the IDaaS user to match the Identity Provider during verification.
If you select Update User (Verification), the IDaaS system user attributes and any existing IDaaS custom user attributes can be set based on claim mappings. After user verification, the IDaaS user attributes are updated with the claim values.
11. Configure Groups, Organizations, and role mapping.
a. Select applicable groups from the Select Group drop-down list to assign created users to groups.
b. Select applicable organizations from the Select Organization drop-down list to assign created users to organizations.
c. In the Group Mapping field, enter the claim containing the group membership for users.
Only existing groups are mapped. If a group is not found, it is not mapped. The mapping does not remove any existing groups. If group mapping is not configured, existing groups remain.
Attention: Group Mapping allows anyone with access to this Identity Provider to have their IDaaS groups include the groups defined by the Identity Provider. Groups set the policies applied to users. Enabling this setting could result in users having access to unexpected policies, especially if the Identity Provider has different user access policies than IDaaS. Analyze the risks before configuring this option.
d. In the Role Mapping field, enter the claim containing the role membership for users.
Only existing roles are mapped. If the role is not found, it is not mapped. The mapping does not remove an existing role. If a role is mapped and is different from the existing role, the existing role is replaced. If role mapping is not configured and if there is an existing role exist, the existing role remains.
Attention: Role Mapping allows anyone with access to this Identity Provider to have their IDaaS account role defined by the Identity Provider, including the super administrator role that has access to all the resources controlled by your IDaaS account. Enabling this setting could result in unexpected access, especially if your Identity Provider has different user access policies than IDaaS. Analyze the risks before configuring this option.
12. Configure User Authentication as follows:
a. Select Enabled for User Authentication.
During authentication, the Identity Provider returns a claim value that is used to find the IDaaS user based on a user attribute. The attribute mappings in the claim must uniquely identify the IDaaS user for mapping to be successful. If mapped successfully, the Identity Provider can be used as an alternative authentication method.
b. In the Domains field, enter the domains returned from the OIDC Identity Provider after authentication. When set, any user ID ending with the domain (for example user@mycompany.com), or one of the domains is linked to the Identity Provider. Separate each domain with a space.
c. From the drop-down list, select the User Attribute used to identity the user to map a claim returned from the Identity Provider to the IDaaS user (for example, User ID/Alias).
d. Enter the Claim used to identify the user, (for example, email).
Example: If you set User ID/Alias as the user attribute, and you set email as the claim to use, the email address is then used to locate the user in IDaaS using the user's User ID/Alias value.
Note:
A claim value must be mapped for mandatory system attributes. If you do
not map a claim value, user creation fails. Claim values must be valid
(for example, the Email attribute requires
a valid email address). Prior to mapping claims to attributes, confirm
with your Identity Provider that the claim value exists.
The same also applies to any custom user attributes that are mandatory.
Prior to mapping claims to attributes, confirm with your Identity Provider
that the claim value exists.
13. Configure at least one User Match Mapping.
– You must configure at least one matching attribute.
– Every configured attribute must match the corresponding Identity Provider claim value and the IDaaS user attribute, which must both exist and match.
– User matching is case-insensitive.
– You can map both system and custom user attributes.
14. Optional. Under User Verification, do the following:
a. Select Enable for User Verification if you want the Identity Provider to be used for verification. For example, you want do this to allow an Open ID Connect Identity Provider to validate a user's photo or private identification information and return corresponding claims that are mapped to the IDaaS user attributes.
b. Configure at least one User Match Mapping.
– You must configure at least one matching attribute.
– Every configured attribute must match the corresponding Identity Provider claim value and the IDaaS user attribute, which must both exist and match.
– User matching is case insensitive.
– You can map both system and custom user attributes.
Note: See Manage user policies for more information on the verification process.
15. Click Save.