Powered by Algolia

    OpenID Connect

    OpenID Connect (OIDC) is a simple identity layer on top of the OAuth 2.0 protocol. It allows Clients to verify the identity of the End-User based on the authentication performed by an Authorization Server, as well as to obtain basic profile information about the End-User in an interoperable and REST-like manner.

    OpenID Connect allows a variety of clients including Web, mobile, and JavaScript clients, to request and receive information about authenticated sessions and end-users. The specification is extensible and allows participants to use optional features such as: encryption, identity data, discovery of OpenID Providers, and session management.

    The example below shows who to integrate an Angular app with OpenIAM using OIDC. However, you can leverage the steps described below integrate your OIDC application with OpenIAM.

    Create an Authentication Provider

    To create a new Authentication provider:

    • Login to the Webconsole and go to Access Control > Authentication Provider
    • Go to Create New Provider
    • Since OIDC is a layer on top of oAuth, OpenIAM combines the UI to configure both oAuth and OIDC clients. Please elect oAuth Client from the "Select a Provider Type" drop down as shown below

    Select authentication client

    Configure OIDC Client Provider in OpenIAM

    Create new authentication provider

    Field NameDescription
    Provider nameThis can be any descriptive name to identify this configuration such as angular-oidc-app
    Redirect URLRedirect URLs are a critical part of the OAuth flow. After a user successfully authorizes an application, the authorization server will redirect the user back to the application with either an authorization code or access token in the URL. Since the redirect URL can contain sensitive information, it is critical that the service doesn’t redirect the user to an arbitrary location.
    Allow multiple Active TokensSet this value to Off , which is the default.
    Signing AlgorithmSelect the algorithm used to sign tokens issued for your application or API. Example is RS-256
    JWT IssuerThis is the JWT Issuer. It identitifies the client that will be issued the JWT token. In this case, we can put any descriptive value like angular-oidc-app
    Final JWT Issuer viewThis value will be automatically generated upon completing the "JWT Issue" value.
    OpenID Connect Discovery URLThis value will be automatically generated upon completing the "JWT Issue" value. You can configure your OIDC application using the information found at the URL.
    Authorization Grant FlowThe grant flow drop down requires the selection of a Grant type. The grant descirts how the client application to acquire an access token which can be used to authenticate a request to an API endpoint. Note: the grant type that you select here, must align with the grant flow that you define in your application. For this example, select Implicit from the drop down.
    Client Authentication TypeDescribes how credentials are passed to the authorization server. You can select between Basic Authentication and Request Body. For this example, select Request Body
    Default ScopesScopes in OAuth 2.0 provide a way to limit the amount of access that is granted to an access token. You can select the scopes from the dropdown. Note that Scopes in OpenIAM are resources and you can manage them through the Resource Manager interface described under Access control.
    Skip scope approvalSet this to Off
    Token expirationAccess token expires after the specified minutes of being idle. You can set this value to 30 minutes.
    Use refresh tokenRefresh tokens carry the information necessary to get a new access token. Whenever an access token is required to access a specific resource, a client may use a refresh token to get a new access token issued by the authentication server. In most cases, this value should be set to Off.
    Protect by 2FASet this value to Off unless you are want to use 2FA during the authentication process.

    The example represents a value Authentication provider configuration for use with the test Springboot application that was referenced earlier in this section..

    Upon saving the configuration, the system will generate the clientid and clientsecret which will be used by your oAuth Client.

    OIDC Authentication provider example

    Grant access to your application

    To be able to access the service provider through the IdP, we must grant access to the service provider by associating it to an entitlement object such as a group / role. While this topic is described in detail in the access control section, the section below provides a brief reference to entitle an application through a role.

    • Go to the Webconsole -> Access Control -> Role
    • Find an existing role which you want to update such that it is entitled to your service provider
    • View the role details by click on the icon in the Actions column
    • Go to the Role Entitlements option from the side menu as shown below

    Role summary view

    • Right click on Resource followed by select Add as shown below

    Role summary view

    • From the Resource type drop down select Authentication provider
    • From the adjacent dropdown, select the name of your authentication provider as shown below

    Entitle role

    The role has now been entitled.

    Previous
    oAuth 2.0
    Next
    OpenIAM oAuth Scopes