Connecting with a custom IDP

Instructions on how to connect a custom IDP to ACP

Process overview

To manage user access, the Cloudenity ACP offers:

  1. Third-party Identity Providers provided out of the box

  2. A possibility to integrate your custom Identity Provider with ACP through the use of Cloudentity APIs

You can integrate your already exsiting login page with ACP and, then, enable your users to log in to the ACP.

ACP does not provide Identity and Access Management solution to store and manage the users' digital identities. This functionality is a part of the Identity solution.

Integrating with a custom Identity Provider

The process of user authentication, when a custom IDP is used, works as follows:

Authentication and consent approval flow

  1. The OAuth 2.0 client initiates the authorize code or implicit flow (1a) and gets redirected by ACP to the custom login page (1b).

    > Status: 302
    > Location:
  2. The custom login page, once the user has successfully logged in (2a), calls ACP to accept the login request and redirects the user to the returned redirect URL (2b).


    The custom login page must pass login_state from query parameters to accept the login request body and use login_id from query parameters as id in the accept login request path.

    curl -X POST "" \
      -d '{ "auth_time": "2019-11-20T08:20:46.294Z", "subject": "", "login_state": "29n93"}' \
      -H "Authorization: Bearer PUT-YOUR-ACCESS-TOKEN-HERE"
    > {"redirect_to": ""}

    The accept login request endpoint requires authentication.

    2.1. In the admin authorization server of the same tenant that you are building the custom login page for, create a client and use its client_id and client_secret to issue the access token.


    Make sure the client credentials grant flow is enabled.

    2.2. Replace PUT-YOUR-ACCESS-TOKEN-HERE with the access token issued by the admin authorization server.

  3. ACP checks if the login request has been accepted and redirects the user to the ACP consent page.

    > Status: 302
    > Location:
  4. The ACP consent page asks the user to grant requested scopes. Upon approval, it accepts the consent request and redirects the user to the returned redirect URL.

  5. ACP checks if both login and consent requests have been approved. If so, it issues the authorization code (or access and ID tokens in the case of the implicit grant flow) and redirects the user to the redirect URL.

    > Status: 302
    > Location:


You can find all ACP login APIs here.

There are three internal-only APIs provided by administrative ACP endpoints that can be used in the authentication and consent approval flow:

  • GET /api/system/{tenant_id}/logins/{login_id} for getting login request details

  • PUT /api/system/{tenant_id}/logins/{login_id}/accept for accepting the login request

  • PUT /api/system/{tenant_id}/logins/{login_id}/reject for rejecting the login request

login_id is provided as a query parameter when the user gets redirected to the login or consent page from the ACP authorize endpoint.

The authorize endpoint is protected using CSRF cookies. If cookies that are associated with a given login are missing, the authorization code (or token) is not issued.


The custom login and consent application provides the /login endpoint.

login_id can be read from query parameters. The request can be approved immediately if the user has already been logged in. Otherwise, the login form gets displayed.

The custom login redirects the user to the URL returned from accept or reject login endpoints.


You need to update the authorization server login_url attribute.

Learn more

See APIs for more information.

Connecting custom IDPs to ACP


Select a workspace

  1. Go to the ACP administrator portal in your browser and log in with your credentials.

  2. From Workspace Directory, select a workspace that you want to enter.

Add an identity provider

  1. Go to Identities.

  2. Click ADD IDENTITY to create a new IDP.

  3. In the Add new provider view, select Custom IDP, enter the name for your IDP, and click Next.

  4. In the Register Custom IDP view, enter the login URL for your IDP that you have integrated with ACP, and select Save.


You have enabled your users to connect to Authorization Control Plane using your custom login page.

Configure advanced settings

Go to Identities in the left sidebar and select your IDP from the list of available IDP connections.

Configure IDP settings

To configure your new IDP advanced settings:

  1. Make sure that you are in the Configuration view and select Advanced settings at the bottom.

  2. Select Authentication Method Reference from the dropdown menu.

  3. Select Save.

Configure authentication context attributes

You can configure authentication context attribues for your custom IDP.

Read more

To know more about authentication context attributes, see the authentication context documentation.

To add an attribute:

  1. Select the Attributes view.

  2. Click the Add attribute button.

  3. In the Add attribute window, specify the following features:

    • Source (ID token, Access token, User object, Root)
    • Display name
    • Variable name
    • Data type
  4. Click Next.

Configure mappings of the attributes

You can map your IDP attributes between your custom IDP and the authentication context.

Read more

To know more about mapping authentication context attributes, see the mapping documentation.

To add a mapping:

  1. Select the Mappings view.

  2. Click the Add mapping button.

  3. Provide the following information on:

    • Source name
    • Target name

Enable stateful authorization

This step is optional.

To have the user’s data cached in ACP and avoid re-authenticating within one use’s session, follow the instruction in Enable the stateful authZ in ACP.

User’s test

Test your connection between the ACP and your custom Identity Provider as a user.


Your provider is configured as a user-authentication method by your administrator.


  1. Use the URL of your existing workspace and select Demo application.

  2. In the displayed Demo application window, click LOG IN TO DEMO APP.

  3. Select your configured IDP (if you have multiple IDPs) and, next, authenticate in the IDP.


ACP 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 the IDP is delivered through the access token and the ID token generated by ACP.

Read more

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

Developer’s test

Test your connection between the ACP and your custom Identity Provider as a user.


Your provider is configured as a developer-authentication method by your administrator. To register your IDP for the developer, follow the instructions in Configure IDP, this time selecting the Developer workspace in step 2.


  1. Use the URL of your existing workspace and select your ACP developer portal to access it.

  2. Log in to your account by entering your login credentials and selecting LOG IN.


You are logged in to the ACP developer portal with the newly-configured IDP.