Overview

Use this policy to authenticate a client by delegating the authentication to an OAuth2 provider. If this policy is applied, it is used to authenticate any request that does not contain credentials for any other authentication policies (such as API Key). The client is redirected to the OAuth provider to start the authentication flow. Once the flow completes, and the access token is obtained, the policy uses it to perform one or more requests to get information about the user, such as the ID and assigned role. Finally, a session cookie is returned to the client, and the client is redirected back to the requested URL. Subsequent requests authenticate based on the session cookie instead of repeating the OAuth flow. This implementation is based on the authorization code flow from Okta.

Starting in the October 2023 release, SnapLogic supports the implementation of OpenID. You can now use your OpenID Connect provider for the authentication controls in your Genric OAuth2 API policy.

Verified Providers

SnapLogic verified the following authentication providers for this policy:

• Okta

• GitHub

• Salesforce

• Ping Identity

• Azure

This policy might work with other authentication providers not listed above but has not been tested and verified.

Policy Execution Order

The Generic OAuth2 policy executes after the other authentication policies, specifically those whose mechanisms are based on the client providing a token in the request, like the API Key or Callout Authenticator policies.

Settings

Examples of Configuring the Generic OAuth2 API Policy with OIDC Providers

Google IdP Application Field Mappings

You can use Google Cloud Services to set up Google as an IdP for your OAuth2.0 policy. Refer to Google Cloud documentation for the account information required to fill out the Generic Oauth2 policy form.

Prerequisites

• A project, with credentials

• OAuth client ID.

Workflow

1. Go to the OAuth Consent Screen under APIs and Services.

2. When you create

3. Create an Application, choose an Application Type, and give it a name.

4. Add your redirect URL under Authorize redirect URIs.

Example Settings

The following table provides the mapping between the Google IdP application endpoints and the Generic OAuth2 policy OpenID field values.

Refer to Google Cloud documentation for the account information required to fill out the Generic Oauth2 policy form.

Azure IdP Application Field Mappings

Microsoft Entra ID

You can use Microsoft Entra ID as an IdP for your OAuth2.0 policy.

Prerequisites

• A project, with credentials

• OAuth client ID.

Workflow

1. Go to the OAuth Consent Screen under APIs and Services.

2. When you create

3. Create an Application, choose an Application Type, and give it a name.

4. Add your redirect URL under Authorize redirect URIs.

Example Settings

The following table provides the mapping between the Microsoft Entra ID application endpoints and the Generic OAuth2 policy OpenID field values, where the application name is 2ada741a-1b5a-49e4-c3bd-fc2a72b698c.

AD B2C Application

Prerequisites

• A tenant

• An active subscription

Workflow

1. Have an active subscription.

2. Create a B2C tenant.

3. Register an app for support type for Accounts in any identity provider or organizational directory (for authenticating users with user flows)

4. Register another support type for Accounts in this organizational directory only (TestingB2CAPIM only - Single tenant)

5. Create a user flow. The user flow functions like a policy.

6. Use your app (for authenticating users with user flows) to get URL endpoints to set up your policy

7. Add an Identity Provider to your B2C tenant using your single-tenant app

8. Add your redirect URI to your single-tenant app https://yourtenantname.youruserflowname.com/yourtenantname.onmicrosoft.com/oauth2/authresp

9. Add your redirect URI, which you provided in the Generic Oauth2 to your app for support type for Accounts in any identity provider or organizational directory (for authenticating users with user flows)

Example Settings

The following table provides the mapping between the Azure AD B2C application endpoints and the Generic OAuth2 policy OpenID field values, where the name of the user workflow (policy-name) is the app name you create for user flows.

Session Management

The OAuth2.0 API Policy might require consideration for active session management from an administrative point of view.  A network issue or company policy might necessitate overriding the Time-to-Live settings. For this purpose, the following APIs allow a SnapLogic Org admin the ability to list session details and delete sessions as needed:

The session management details returned includes the session ID and user or client details upon making the API call. Below is the sample response upon using the GET HTTP method:

[
    {
        "type": "TaskSession$OauthSession",
        "username": "105450719975802175246",
        "roles": [
            "openid",
            "email",
            "profile"
        ],
        "session_id": "0f9eb160-b5ed-4cba-94ea-b5a3ae1fc9e0",
        "expires_at": 1718323653745
    },
    {
        "type": "TaskSession$OauthSession",
        "username": "105450719975802175246",
        "roles": [
            "openid",
            "email",
            "profile"
        ],
        "session_id": "79258c26-e361-46c5-9588-5301434a738a",
        "expires_at": 1718323838403
    }
]

Related Content

• SnapLogic API Management

• Managing your Developer Portal Settings

• API Policy Manager

• API Insights