Try WSO2 Cloud for Free
Sign in

All docs This doc

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Further modifications based on ✉️: [API Cloud] [Documentation] Request to re-organize and rename external users related documentation

Single Sign-On (SSO) allows users, who are authenticated against one application, to gain access to multiple other related applications without having to repeatedly authenticate themselves. It also allows the web applications to gain access to a set of back-end backend services with the logged-in user's access rights, and the back-end . The backend services can authorize the user based on different claims like the user role. An Identity Provider (IDPIdP) is responsible for issuing identification information and authenticating users by using security tokens. WSO2 API Cloud uses WSO2 Identity Server as the default Identity provider (IDPIdP). An organization can have it’s own IDP IdP that provides authentication for internal users. In such scenarios, the organization can link their IDP IdP to WSO2 Identity Cloud to provide SSO based authentication for API Cloud apps.

The diagram below shows how an external IdP-based SSO is configured.

Image Added

  1. The user visits the API Cloud application.

  2. A SAML authentication request is sent to the Identity Cloud.

  3. Identity Cloud is configured to forward the authentication requests received for a particular organization to an external IdP.

  4. The organization’s IdP prompts the login window and the user submits the credentials.

  5. An authentication success response is sent back to the Identity Cloud.

  6. Identity Cloud sends a SAML response to the corresponding API Cloud application. Before sending the response, Identity Cloud stores (provisions) the permission information of the authenticated user in an internal user store. The API Cloud applications refer to this user store for authorization.


In this tutorial, you learn how to configure an External Identity Provider external identity provider for API Cloud authentication.

  1. Log in to WSO2 API Cloud. Click Support in the top menu bar, and submit a support request. To configure an external identity provider, you need to provide the name of your preferred identity provider.
    Image Removed

    The WSO2 team will contact you and get the required information and configure your IDP in the Identity cloud.

    InfoThe users Configure > External Users
    Image Added
  2. In the API Cloud Web UI Access tab, select Connect Your Identity Provider and submit the identity provider details. 


    If your IdP is not listed in the drop-down menu, select Other.

    Image Added

  3. The WSO2 team will contact you, get the required information, and configure your IdP in the Identity Cloud.


    Users in your user store can have different roles. You may want to restrict the access to the API Cloud apps applications for the users in your user store. In such cases, you can send a roles attribute with the IDP IdP authentication response and we will map it with this attribute will be mapped to the cloud-related roles. This capability depends on your IDPIdP.

    When the role information is not present in the response (ex- e.g. Google OpenID-Connect), Identity cloud Cloud maps the authenticated user to the organization’s default internal role. We can assign subscribe/create/publish/admin permissions to this role. All the authenticated users will have the same role and the same set of permissions. Permissions should be determined based on your organizational organization's needs.


    WSO2 supports only the email address as the user ID. Therefore, your IDP Will IdP will have to send the email address in the response.

  4. Configure custom URLs for SSO login.


    API Cloud applications identify secondary user-store configured organizations organizations with an external IdP configured, based on a specific custom header. When the header is available in the request, the application executes the secondary userthe external IdP-store based authentication flow. If the header is unavailable, the default authentication flow is executed. This custom header is sent through custom URL configurations. Let’s say we have configured a load balancer to send the custom header with Then, which , which does not have a custom header will be , is executed with the default authentication flow., which includes a custom header secondary user store , is executed with the external IdP-based authentication flow.

    For details on how to configure a custom URL for the API Cloud Store, see Customize Cloud URLs.

    Configuring a custom URL for API Publisher and Admin Apps

    To configure custom URLs for the API Cloud Publisher and Admin apps, you have to submit a support request as described in step 2 (This this will be supported through a UI in the future).

    Provide the following information to configure custom URLs:

    • Custom Domain

    • SSL Certificates
    • SSL Key and Chain Files

    You can always use the default cloud URLs and login log in to your cloud Cloud account for administrative tasks.

  5. WSO2 will inform you once the configurations are completed. You will be able to create, publish, subscribe and invoke APIs after completion.


    Token API: You will not be able to use Password Grantuse the password grant to generate access tokens because your credentials are unavailable in our user store.