How-tos

Set Up Entrust for Authentication

Instructions on how to connect the Entrust IDP to Cloudentity

About Entrust as IDP

Entrust IDP is natively supported by Cloudentity as an OIDC Identity Provider, which means that it has a dedicated connection template in Cloudentity for your convenience. Entrust applications can implement the OIDC protocol, providing the proof of user authentication to Cloudentity within an ID Token and Access Token.

The client authorization flow with Cloudentity connected to Entrust looks as follows:

[mermaid-begin]
sequenceDiagram participant Client app participant Cloudentity participant Entrust IDP Client app->>Cloudentity: Request authorization code Cloudentity->>Entrust IDP: Request authorization code Entrust IDP-->>Entrust IDP: Authenticate user Entrust IDP-->>Entrust IDP: Ask user for consent to share data with Cloudentity Entrust IDP-->>Cloudentity: Issue authorization code Cloudentity->>Entrust IDP: Request tokens using the code Entrust IDP-->>Cloudentity: Issue tokens opt Cloudentity->>Entrust IDP: Request user/group information Entrust IDP-->>Cloudentity: Return user/group data end opt Cloudentity-->>Cloudentity: Ask user for consent to share data with client app end Cloudentity-->>Client app: Issue authorization code Client app->>Cloudentity: Request tokens using the code Cloudentity-->>Client app: Issue tokens requested by the app
  1. Client app requests the authorization code from Cloudentity.

  2. Cloudentity requests the authorization code from Entrust IDP.

  3. Entrust authenticates the user and asks for consent to share data with Cloudentity.

  4. Entrust issues the code to Cloudentity after user’s authentication.

  5. Cloudentity requests tokens from Entrust using the provided code.

  6. Entrust issues the tokens to Cloudentity.

  7. Optionally, Cloudentity can use the token to pull additional user and group information, but only when the Get user info and Fetch groups option are selected in the connector.

  8. Cloudentity asks for user consent to share data with the client app, unless the client app is marked as trusted or the requested scopes were already granted for this app.

  9. Cloudentity issues the authorization code to the client app.

  10. Client app requests the tokens from Cloudentity.

  11. Cloudentity issues the tokens to the client app. Cloudentity tokens are minted based on the incoming Entrust tokens with claims mapped to Cloudentity’s authentication context.

The following steps in the flow are optional:

  • Cloudentity only pulls user and group information if these options are explicitly enabled in the Entrust connector configuration, as explained later in this document.
  • Cloudentity only asks for consent if the client application is not marked as trusted and requests scopes which were not granted previously (or scopes for which the user’s consent has been withdrawn).

Entrust and SAML

Entrust applications can also use the SAML protocol, but this integration is not natively supported by Cloudentity. If necessary, you can use the generic SAML connector to bind Entrust apps via SAML.

Prerequisites

  • You have an Entrust account.

  • You have an OAuth application registered in your Entrust domain with the following settings:

    • Grant types supported must include Authorization Code.

    • The following scopes are enabled: openid, email, and profile.

    • If you want Cloudentity to fetch group data from Entrust, add the groups claim to your Entrust application as shown below:

      Entrust group configuration

Connect Entrust in Cloudentity

Basic Configuration

  1. In your workspace, go to Identity Data > Identity Providers > Create Identity.

  2. Select the Entrust template and click Next.

  3. Add the redirect URL from Cloudentity as Login Redirect URI(s) in your Entrust OAuth app.

  4. In the Entrust form, enter the required prameters.

    Parameter Description
    Name Name for your Cloudentity’s Entrust connection. This name allows users to identify the IDP they need to authenticate with.
    Domain Entrust domain where the IDP app is registered, similar to example.us.trustedauth.com. Do not include the protocol in the domain.
    Client ID Client ID of the application registered with Entrust
    Client secret Secret of the application registered with your Entrust
  5. Optionally, enable Authentication context caching.

    Tip

    You can enable the authentication context caching if you wish to store the user’s authentication context locally. If you do, specify the cache Time To Live as well. Learn more by reading Stateful authorization with Cloudentity.

  6. Select Save.

    Result

    Your new IDP connection is created and you can now configure the advanced settings if necessary. Users can now authenticate via the OIDC-compliant IDP.

Configure Advanced Settings

  1. From the Identities > YOUR_IDENTITY > Configuration page, select Advanced settings at the bottom.

  2. In the Authentication Method Reference, you can select an authentication method to be written into the amr object returned by the IDP. The amr object is created if it doesn’t exist. If it exists, its values are replaced with the selected item.

  3. Optionally, enable the Get user info option.

    Note

    If you enable the Get user info option, Cloudentity will call the Entrust userinfo endpoint to retrieve additional user attributes.

  4. Optionally, enable the Fetch groups option. If you do, Cloudentity will fetch the user’s group data from Entrust.

  5. Select Save.

Entrust ACR to AMR Mapping

Entrust IaaS maps the Authentication Context Class Reference (ACR) to Authentication Method Reference (AMR) in a specific way. A SAML URI is written to ACR and then AMR is written based on the ACR value, in accordance with the following rules (acr to the left, amr to the right):

"urn:oasis:names:tc:SAML:2.0:ac:classes:Password" -> "pwd"
"urn:oasis:names:tc:SAML:2.0:ac:classes:TimeSyncToken" -> "swk"
"urn:oasis:names:tc:SAML:2.0:ac:classes:MobileTwoFactorContract" -> "mfa"
"urn:oasis:names:tc:SAML:2.0:ac:classes:SmartcardPKI" -> "sc"
"urn:oasis:names:tc:SAML:2.0:ac:classes:unspecified" -> "pwd"

Add Custom OIDC IDP Attributes

If your IDP returns custom claims outside of the standard OIDC scope, make sure to add them to the IDP connector so that they can be recognized and mapped to the authentication context.

  1. Go to Identity Data > Identity Providers and select an IDP from the list.

  2. Open the Attributes page. A standard list of OIDC attributes returned by this IDP appears.

  3. Select Add attribute. In case of Entrust, the source of data is always the User info endpoint of your Entrust OAuth application.

  4. Fill in the form.

    Option Description
    Claim name Name of your custom attribute matching the incoming IDP claim
    Display name User-friendly name for the custom attribute
    Data type Data type matching that of the incoming IDP claim

    Claim names with a . character

    If the incoming attribute has a . character in the name, the dot must be explicitly escaped using \. when defining the IDP attribute. For example, claim name https://example.com/groups must be entered as https://example\.com/groups.

  5. Save your changes and proceed to mapping the attributes to the authentication context.

Map IDP attributes to authentication context

If you’ve added custom attributes for an IDP, you need to make sure they are mapped to the authentication context. You can do it either from the IDP configuration page (as explained here) or use Data Lineage instead.

Default OIDC/SAML attributes are mapped out of the box.

  1. Go to Identity Data > Identity Providers and select an IDP from the list.

  2. Open the Mappings page. A standard attribute mapping for this IDP appears.

  3. Select Add mapping and map any custom IDP attributes to an existing authentication context attribute.

    Note

    If you need to create new authentication context attributes, read Setting up authentication context.

  4. Optionally, assign a post-authentication extension to modify your authentication context before issuing the token to the client. Attributes returned by the script do not need to be separately mapped to the authentication context.

  5. Save your changes. Your mapped custom attributes should now be shared in the ID token issued to your client application, given that the target application requests them (you can check this in Data Lineage).

Test Entrust IDP

Prerequisite

Your provider is configured as a user-authentication method by your administrator. Workspace with a demo application is available.

Test

  1. Open the user portal.

  2. Select LOGIN TO DEMO APP.

  3. Select your configured IDP and, next, authenticate in IDP.

Result

Cloudentity displays the consent page that lists data scopes to be shared with the application. When you proceed to the application (ALLOW ACCESS), the PII data coming from IDP is delivered through the access token and the ID token generated by Cloudentity.

Read More

For information on granting and managing Cloudentity consents, see Cloudentity OAuth consents.

Updated: Jul 11, 2022