Enterprise App Store and Testing Distribution Single Sign-On (SSO) Providers Configuration
1. Introduction
Single Sign-On (SSO) allows users to log in to Appcircle using their existing credentials from an Identity Provider (IdP). By integrating SSO, organizations can streamline user access management, enhance security, and provide a seamless login experience across multiple platforms.
This document specifically covers the SSO configuration for the Testing Portal (Testing Distribution module) and Enterprise Store (Enterprise App Store module). Please note that a separate SSO configuration exists. This document does not cover those configurations for the Appcircle Portal. For more information on SSO setup for the Testing Portal and Enterprise Store, please refer to the Appcircle Login Single Sign-On (SSO) Providers Configuration.
Currently, this configuration supports enabling SSO with only one identity provider at a time. Adding multiple SSO providers is not supported at this moment but may be available in the future.
The SSO setup described in this document integrates the selected identity provider with the Appcircle IAM module, essentially adding the provider as an identity source for Appcircle.
This document provides a comprehensive guide to configuring SSO with various supported identity providers, including Auth0, Microsoft Entra ID (formerly Azure Active Directory), Okta, OneLogin and Keycloak. Whether you choose to implement OpenID Connect or SAML, this guide will walk you through the necessary steps to ensure a successful integration with Appcircle.
Supported Identity Providers
- Auth0:
- Auth0 (OpenID Connect)
- Auth0 (SAML)
- Microsoft Entra ID (formerly Azure Active Directory):
- Microsoft Entra ID (SAML)
- Okta:
- Okta (OpenID Connect)
- Okta (SAML)
- OneLogin:
- OneLogin (SAML)
- Keycloak:
- Keycloak (OpenID Connect)
- Keycloak (SAML)
Each section will provide detailed instructions for configuring your chosen identity provider, including screenshots and troubleshooting tips to ensure a smooth setup process.
2. Prerequisites
Before you begin configuring SSO for Appcircle, ensure that you have the following prerequisites:
- An active account with one of the supported Identity Providers (IdPs).
- Administrative access to both the Identity Provider and Appcircle's platform. For more details, refer to the Appcircle Role Management Documentation.
- Access to SAML tracing tools or other relevant debugging resources.
- SSL certificates (if required by your IdP).
These prerequisites will ensure that the SSO configuration process is smooth and any issues that arise can be quickly resolved.
SSO Terminology
Understanding the following key terms will help you navigate the SSO configuration process more effectively:
- Identity Provider (IdP): The service responsible for authenticating the user and issuing identity information. Common examples include Auth0, Microsoft Entra ID, Okta, OneLogin, and Keycloak.
- Service Provider (SP): The service (in this case, Appcircle) that relies on the IdP to authenticate users and grant them access. The SP uses the identity information provided by the IdP to manage user sessions and permissions.
- SAML Assertion: A secure XML document sent by the IdP to the SP, containing the user's authentication and authorization information. This document is a core component of the SAML protocol, used to establish a user’s identity across different services.
- OpenID Connect Token: A token used in the OpenID Connect protocol to convey identity information from the IdP to the SP. This token typically includes user information and is crucial for establishing secure communication between the IdP and SP.
These terms form the foundation of the SSO process, where the IdP authenticates the user and the SP relies on this authentication to grant access. For more in-depth information, refer to the OpenID Connect specification or the SAML specification.
3. General Configuration Steps
The following steps outline the general process for configuring Single Sign-On (SSO) with Appcircle, applicable to all supported identity providers. These steps will guide you through the initial setup within the Appcircle dashboard and the configuration within your chosen identity provider.
Step 1: Enable SSO in Appcircle
Begin by enabling SSO within your Appcircle organization settings. Follow these steps:
- In the Appcircle dashboard, navigate to the Organization section located on the far left sidebar.
- On the My Organization screen, select Integrations from the left-hand menu.
- In the Integrations screen, find the Authentications area on the far right, and click the Connect button.

- The Enable SSO for Organizations window will open, presenting two options:
- Set up OpenID Provider
- Set up SAML SSO Provider

- In the setup window, manually enter a unique Alias for your organization.
- Additionally, enter a Display Name for your organization.
- After setting the alias and Display Name, Appcircle will automatically generate the Store Redirect URL and Distribute Redirect URL specific to your configuration. Store Redirect URL and Distribute Redirect URL must be used in your identity provider's settings to ensure proper redirection after authentication.

Ensure that the alias and Display Name you choose are unique and easily identifiable, as they are essential for the SSO authentication process. The Store Redirect URL and Distribute Redirect URL are crucial for your SSO setup, so be sure to copy and save them for use in the following steps.
Step 2: Select and Configure Your Identity Provider
After enabling SSO and setting your alias, proceed to select and configure your identity provider:
- Depending on the option you selected in the previous step, you will either be configuring an OpenID Connect or SAML provider.
- Follow the specific steps for your chosen provider to enter the necessary configuration details, including Client ID, Client Secret, and other required parameters.
- Use the previously generated Store Redirect URL and Distribute Redirect URL provided by Appcircle when configuring your identity provider settings to ensure proper redirection after authentication.
Only one SSO provider can be configured at a time.
Step 4: Test and Verify
After completing the SSO configuration, it's essential to test and ensure everything is functioning correctly. The following steps outline the testing process.
Step 4.1: Test and Verify SSO Configuration for Enterprise Store (Enterprise App Store module)
Begin by enabling SSO for the Enterprise App Store. Follow these steps:
- In the Appcircle dashboard, navigate to the Enterprise App Store section located on the far left sidebar.
- On the Enterprise App Store screen, select Settings from the left-hand menu.
- Click on the Activate button next to SSO Login.

- Follow Enterprise App Store Documentation to test the integration.
Step 4.2: Test and Verify SSO Configuration for Testing Portal (Testing Distribution module)
Begin by enabling SSO for the Testing Portal. Follow these steps:
- In the Appcircle dashboard, navigate to the Testing Distribution section located on the far left sidebar.
- On the Testing Distribution screen, select Distribution Profiles from the left-hand menu.
- Select the relevant Distribution Profile to be distributed via SSO authentication.

- On the Distribution Profile screen, click on the Settings button.

- Navigate to the Authentication tab and select SSO Login as the authentication type.

-
Follow the Share Binary documentation to distribute application. You can share application to your email address that exist on Identity Provider for testing purposes.
-
Check your email inbox and goto link in email.

4. Specific Provider Configuration
4.1 Auth0 (OpenID Connect)
Auth0 is a popular identity provider that supports the OpenID Connect protocol, which can be integrated with Appcircle for secure authentication.
Step 1: Create an Application in Auth0
To start, log in to your Auth0 dashboard and create a new application for Appcircle:
- In the Auth0 dashboard, navigate to the Applications section.
- Click Create Application and choose a name for your application (e.g., "Appcircle SSO - OpenID").

- Select Regular Web Applications as the application type.
- Click Create button.

- Once application created, navigate to the Settings of application.
- Take note of the Client ID and Client Secret, which will be needed later.

Step 2: Configure Callback URLs in Auth0
Next, configure the callback URLs in Auth0 to ensure proper redirection to Appcircle after authentication:
- In the Auth0 dashboard, go to the Settings tab of your application.
- In the Allowed Callback URLs field, enter the Store Redirect URL and Distribute Redirect URL (created using the alias in "Step 1: Enable SSO in Appcircle" from the "General Configuration Steps" section), combined by a comma.
Example Callback URL: https://auth.appcircle.io/auth/realms/store/broker/identity-{your-alias}/endpoint,https://auth.appcircle.io/auth/realms/distribute/broker/identity-{your-alias}/endpoint

- Click on the Save Changes button.
Step 3: Download OpenID Configuration from Auth0
Instead of writing all the settings of OpenID, you can download the settings file from Auth0 and import in Appcircle. Download the OpenID configuration JSON file from Auth0 with following steps.
- In the Auth0 dashboard, go to the Settings tab of your application.
- Scroll to the bottom of the page and expand the Advanced Settings section.
- Navigate to the Endpoints tab.
- Copy and open OpenID Configuration URL in different tab in your browser.
- Save OpenID Configuration as json file.
