Skip to main content

Idp OAuth 2.0 code flow setup

Overview​

OAuth 2.0 is an authorization framework that enables third-party applications to obtain limited access to an HTTP service, either on behalf of a resource owner or by allowing the third-party application to obtain access on its own behalf. OAuth 2.0 provides authorization flows for web and mobile applications to securely access resources on behalf of a user.

Akkess IAM supports OAuth 2.0 authorization code flow for issuing IAM token. To enable OAuth 2.0 authorization code flow, you need to configure the OAuth 2.0 client in the Idp and provide the client details in the Akkess IAM Idp configuration. Properties like

  • client_id
  • client_secret
  • authorization_url
  • token_url
  • userinfo_url
  • subject attribute mapping

are needed to be configured in the Akkess IAM Idp configuration.

To simplify the IAM console has templates for common Idp's OAuth 2.0 code flow setup.

Idp template

Common Idp's OAuth 2.0 code flow setup​

Google​

Step 1: Create a Google Cloud Project​

  1. Go to the Google Cloud Console.
  2. Click Create Project, provide a name, and click Create.
  3. Select your project from the dropdown in the navigation bar.

Step 2: Enable APIs and Services​

  1. Navigate to APIs & Services > Library.
  2. Enable the Google People API.
  1. Go to APIs & Services > OAuth Consent Screen.
  2. Fill in required fields:
    • App Name
    • Support Email
    • Developer Contact Information
  3. Save and proceed.

Step 4: Create OAuth Credentials​

  1. Navigate to APIs & Services > Credentials.
  2. Click Create Credentials > OAuth 2.0 Client IDs.
  3. Add the Redirect URI and save the Client ID and Client Secret.

Facebook​

Step 1: Create a Facebook App​

  1. Go to the Facebook Developers Portal.
  2. Click Create App, choose Consumer, and provide a name.
  3. Complete the app setup.

Step 2: Configure OAuth​

  1. Navigate to Settings > Basic.
  2. Add your Redirect URI under OAuth Redirect URIs.
  3. Save the App ID and App Secret.

Step 3: Implement OAuth in Your App​

  • Use the App ID and App Secret to handle the OAuth flow securely.

GitHub​

Step 1: Register Your Application​

  1. Go to GitHub Developer Settings.
  2. Click New OAuth App and provide details:
    • Application Name
    • Homepage URL
    • Authorization Callback URL

Step 2: Note Your Credentials​

  • Save the Client ID and Client Secret.

Step 3: Use OAuth in Your App​

  • Use these credentials to manage the OAuth 2.0 flow in your app.

Microsoft​

Step 1: Register an App in Azure AD​

  1. Go to the Azure Portal.
  2. Navigate to Azure Active Directory > App Registrations > New Registration.
  3. Provide a name and Redirect URI.

Step 2: Configure API Permissions​

  1. Add permissions for openid, email, and profile.
  2. Grant admin consent if required.

Step 3: Note Your Credentials​

  • Save the Application (client) ID and Directory (tenant) ID.
  • Generate a Client Secret.

Step 4: Implement OAuth​

  • Use these credentials to initiate OAuth 2.0 in your app.

Apple​

Step 1: Register a Service ID​

  1. Log in to the Apple Developer Console.
  2. Go to Certificates, Identifiers & Profiles > Identifiers > Service IDs.
  3. Create a new Service ID and enable Sign In with Apple.

Step 2: Configure the Redirect URI​

  1. Add your Redirect URI to the Service ID configuration.
  2. Save your Client ID.

Step 3: Generate a Key for Authentication​

  1. Go to Keys > Create a Key.
  2. Enable Sign In with Apple.
  3. Save the Key ID and download the private key file.

LinkedIn​

Step 1: Register Your App​

  1. Log in to the LinkedIn Developer Portal.
  2. Click Create App, provide details, and submit.

Step 2: Configure OAuth​

  1. Go to your app settings and add your Redirect URI.
  2. Save your Client ID and Client Secret.

Step 3: Enable Permissions​

  • Enable scopes such as r_liteprofile and r_emailaddress.

Step 4: Use OAuth in Your App​

  • Use your Client ID and Client Secret to handle OAuth 2.0 securely.

TikTok​

Step 1: Register Your App​

  1. Go to the TikTok Developer Portal.
  2. Sign in and click My Apps.
  3. Click Create App and provide the necessary details (name, description, etc.).

Step 2: Configure OAuth Settings​

  1. Navigate to App Settings.
  2. Add your Redirect URI (e.g., https://yourapp.com/oauth2callback).
  3. Save the changes and note your Client Key and Client Secret.

Step 3: Implement OAuth in Your App​

  • Use the Client Key and Client Secret to initiate the Authorization Code Flow.
  • Ensure your app handles the redirect URI securely.

PayPal​

Step 1: Create a PayPal App​

  1. Log in to the PayPal Developer Dashboard.
  2. Navigate to My Apps & Credentials.
  3. Click Create App, name it, and select the sandbox/live environment.

Step 2: Configure OAuth​

  1. Note the Client ID and Secret for your app.
  2. Add your Redirect URI under the App Settings.

Step 3: Enable Scopes​

  • Ensure that necessary scopes like openid, profile, and email are enabled.

Step 4: Use OAuth in Your App​

  • Use the credentials to handle the OAuth 2.0 flow in your app securely.

WeChat​

Step 1: Register on the WeChat Open Platform​

  1. Go to the WeChat Open Platform.
  2. Sign in and create an application.

Step 2: Configure OAuth​

  1. Add your Redirect URI under Authorized Callback Domain.
  2. Save and note your AppID and AppSecret.

Step 3: Implement OAuth​

  • Use the WeChat API with your credentials to initiate the flow.

Reddit​

Step 1: Create a Reddit App​

  1. Log in to the Reddit Developer Portal.
  2. Click Create App and provide details (name, description, etc.).
  3. Select Web App and add your Redirect URI.

Step 2: Configure OAuth​

  1. Note your Client ID and Secret.
  2. Use the provided credentials to handle the OAuth flow.

Step 3: Implement OAuth in Your App​

  • Ensure your app securely handles redirect URIs and stores sensitive credentials.

Auth0​

Step 1: Create an Auth0 Tenant​

  1. Log in to the Auth0 Dashboard.
  2. Click Create Tenant and provide the necessary details.

Step 2: Configure Applications​

  1. Navigate to Applications > Create Application.
  2. Choose Regular Web Application.
  3. Add your Redirect URI in the application settings.

Step 3: Use OAuth in Your App​

  • Note the Client ID and Client Secret.
  • Ensure your backend securely handles sensitive credentials and redirect URIs.

Okta​

Step 1: Create an Okta Developer Account​

  1. Go to the Okta Developer Console.
  2. Sign up or log in to your account.

Step 2: Configure OAuth Settings​

  1. Create a new app in Applications > Add Application.
  2. Select Web and configure your app.
  3. Add your Redirect URI in the app settings.

Step 3: Note Your Credentials​

  • Save your Client ID and Client Secret for the app.

Step 4: Implement OAuth​

  • Use the credentials in your application to manage OAuth 2.0 flow securely.

Keycloak​

Step 1: Set Up Keycloak​

  1. Access your Keycloak Admin Console.
  2. Create a Realm or select an existing one.

Step 2: Register a Client​

  1. Go to Clients > Create.
  2. Provide a Client ID and configure the client.
  3. Add your Redirect URI in the client settings.

Step 3: Secure OAuth Flow​

  • Note the Client ID and Client Secret.
  • Configure your application to handle the Authorization Code Flow securely.

Azure AD​

Step 1: Register Your Application​

  1. Log in to the Azure Portal.
  2. Go to Azure Active Directory > App Registrations > New Registration.
  3. Provide a name and add your Redirect URI.

Step 2: Configure API Permissions​

  1. Add necessary API permissions (e.g., openid, email, profile).
  2. Grant admin consent if required.

Step 3: Note Your Credentials​

  • Save the Application (client) ID and Directory (tenant) ID.
  • Generate a Client Secret.

Step 4: Implement OAuth​

  • Use the credentials to initiate and manage OAuth 2.0 flows in your app.

Ping Identity​

Step 1: Access Ping Identity Admin Console​

  1. Log in to your Ping Identity Admin Console.
  2. Create or select an existing Application.

Step 2: Configure OAuth​

  1. Add your Redirect URI to the application configuration.
  2. Save the Client ID and Client Secret.

Step 3: Implement OAuth​

  • Use the credentials in your app to securely manage OAuth 2.0 flow.

References​

  • Each IdP's developer documentation is recommended for detailed setup instructions and specific configurations.
Copyright © 2019 Akkess