Configuring OIDC for SSH and Aporeto control plane users
Before you begin
Familiarize yourself with the following sequence, particularly the bolded URLs. Hover over the numbers for additional details.
Once the user obtains an Aporeto token containing the claims from the identity provider, they can use it to access:
- Aporeto control plane
- Aporeto web interface
- Remote hosts via secure shell (SSH)
Aporeto checks the policy you've defined against the claims in the Aporeto token to determine whether to allow the user access.
Adding Aporeto to the identity provider
While OIDC is a standard, each identity provider provides a different web interface. This section guides you through the setup at a high level.
Many identity providers orient their offerings towards developers. Good news! With Aporeto, you won't need to write any code to integrate with the identity provider.
Web application: Identity providers often support a variety of application types. If prompted, select web application.
Callback URLs: Supply the identity provider with the following whitelist of callback URLs. Identity providers sometimes refer to these as redirect URIs or login redirect URIs.
Client ID and client secret: The identity provider supplies a client ID and a client secret value. These values allow Aporeto to communicate with the identity provider. Store these values in a safe place. You'll need them in subsequent procedures.
Scopes: Though Aporeto sends the desired scopes in its request, some identity providers may ask you to identify the scopes during the configuration. If so, supply the scopes to the identity provider. For a detailed discussion of scopes, refer to the Overview.
Confirming the identity provider's discovery endpoint
Most identity providers offer a discovery endpoint, although this is optional in the specification. Aporeto requires the discovery endpoint. Confirm that your identity provider supports it as follows.
Obtain the identity provider's URL. Your identity provider should make this value easy to obtain, but we provide some tips below.
Provider Example Discussion Auth0
All clients use the same path. Microsoft Azure Active Directory
Append your tenant ID to
The base URL is the same as the path in your browser when you access your account, without the
-adminstring. For example, if I access my Okta account at
https://dev-289699-admin.okta.com, my base URL is
/oauth2to the base URL. Then append the ID of your authorization server. If you have an Okta developer account, the ID is probably
Set an environment variable containing the identity provider's URL. An example follows. Replace
<identity-provider-url>with the identity provider's URL before issuing the command.
Confirm that your identity provider supports the discovery endpoint by issuing the following command.
It should return the JSON details of the OIDC configuration.
If you don't have curl installed, try replacing
wgetin the above command.
Adding the identity provider to Aporeto
In the Aporeto web interface, expand Authentication Sources and select OIDC Providers.
Click the Create button to add a new identity provider.
Type the name of the identity provider in the Name field.
If you have more than one identity provider, users must manually type this name to identify their identity provider. It is case sensitive.
In the Endpoint field, add the identity provider's URL. If you completed the steps in Confirming the identity provider's discovery endpoint, you can retrieve this value via
Paste the client secret in the Client Secret field and the client ID in the Client ID field.
Type the requested scopes in the Scopes field, pressing ENTER after each one. At a minimum, you must have
openid. If the identity provider supports refresh tokens and you would like to enable this feature, also include the
offline_accessscope. For more detail on scopes, refer to the Overview
To set this as the default identity provider, select Use this provider as the default.
We recommend setting at least one identity provider as the default.
Type the claims that correspond to the scopes you specified in the Scopes field, pressing ENTER after each one. This adds the values of the claims from the identity provider to the Aporeto token, allowing you to identify the user and determine whether or not to authorize them. Examples follow.
Scope Claim Description
Adds the user's last name to the Aporeto token. Adds the user's email address to the Aporeto token.
Adds the value for the
groupsclaim to the Aporeto token. The type of value returned by the identity provider varies. Configure your identity provider to return an array or a string, as Aporeto ignores booleans.
* Not available from all identity providers.
Creating an API authorization
Expand Namespace Settings, click Authorizations, and click the Create button.
Type a name for the policy.
If you want the user to have access to all of the children of the current namespace, select Propagate to child namespaces.
If you do not want this policy to be visible in the child namespaces, select Hide propagation to child namespaces.
@auth:realm=oidcin the Subject field and press ENTER. Then type the Aporeto tag that defines the value of the claim that must appear in the user's Aporeto token. Some examples follow.
Identity provider Scope requested Example claim key or value Aporeto tag all
Microsoft Azure Active Directory
Microsoft Azure Active Directory
You can include multiple tags connected by AND or OR to form a logical expression.
Select the namespace that you want to allow the user to access from the Target Namespace list box.
If you want to require the user to attempt their login from a certain subnet or subnets, specify the subnet or subnets in the List of authorized subnets field.
Select the roles that the user should have.
Congratulations! The user should now be able to click Sign in with OIDC to access the Aporeto web interface and use
apoctl auth oidcto log into