How-tos

Set Up Cloud Identity Plane for Authentication

Instructions on how to connect applications registered in Cloud Identity Plane as Cloudentity's (Cloudentity's) Identity Provider.

About Cloudentity IDP

Cloudentity IDP (CIP) is natively supported by Cloudentity as an Identity Provider, which means that it has a dedicated connection template in Cloudentity for your convenience. Since this IDP is provided by Cloudentity, the integration is simple and seamless.

The authorization flow with Cloudentity connected to CIP looks as follows:

[mermaid-begin]
sequenceDiagram participant Client app participant Cloudentity participant Cloudentity IDP Client app->>Cloudentity: Request login Cloudentity->>Cloudentity IDP: Redirect Cloudentity IDP-->>Cloudentity IDP: Authenticate user Cloudentity IDP-->>Cloudentity IDP: Ask user for consent to share data with Cloudentity Cloudentity IDP-->>Cloudentity: Call the /login/accept Cloudentity endpoint Cloudentity->>Cloudentity IDP: Return redirect URL Cloudentity IDP-->>Cloudentity: Redirect user opt Cloudentity-->>Cloudentity: Ask user for consent to share data with client app end Cloudentity-->>Client app: Issue tokens requested by the app
  1. Client app tries to log in to Cloudentity.

  2. Cloudentity redirects the user to CIP.

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

  4. CIP calls Cloudentity’s /login/accept endpoint after successful authentication.

  5. 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.

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

The following steps in the flow are optional:

  • 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).

Prerequisites

Connect Cloudentity IDP in Cloudentity

Basic Configuration

  1. In your workspace, go to Identity data > Identity providers > Create Identity.

  2. Select the Cloudentity IDP template and click Next.

  3. In the Cloudentity IDP form, enter the Name and Login URL.

    Parameter Description
    Name Name for your Cloudentity’s Cloudentity IDP connection. This name allows users to identify the IDP they need to authenticate with.
    Login URL URL pointing to the address of the CIP instance you’re integrating with. Use the base URL only, as in https://example.com.
  4. Save your changes. Client ID, Client Secret, and Issuer URL are generated. Use them to complete the integration on the CIP side.

  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. Users can now authenticate via the OIDC-compliant IDP.

Configure Advanced Settings

  1. From the *Identity data > Identity providers > 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. Select Save.

Add Custom OIDC IDP Attributes

If your Cloudentity IDP returns custom claims outside of the default 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 Identities 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.

  4. Fill in the form.

    Option Description
    Attribute 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 Cloud Identity Plane

Prerequisite

Your provider is configured as a user-authentication method by your administrator. Demo workspace 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.