Registering OAuth2 Client

🎯 Purpose

The REL-ID Gateway Management console Administrator creates an enterprise configuration for OIDC workflow integration, including redirect URI specification for successful authentication.


🔄 Registration Steps

📋 Step-by-Step Process

  1. Access Gateway Management
    • Log in to the Gateway Management console • Navigate to enterprise configuration section

  2. Navigate to Enterprise Management
    • Go to Enterprise Management section • Access client registration interface

  3. Initiate New Enterprise Creation
    • Click on "Add New Enterprise" button • Begin enterprise configuration process

  4. Configure Authentication Type
    • Select "Authentication Type" as "OAuth 2" from dropdown • Establish OAuth2 as the integration protocol

  5. Set OIDC Resource IDs
    • Select appropriate OIDC Resource IDs • Configure OpenID Connect resource access

  6. Enterprise Identification
    • Enter unique Enterprise ID • Provide identifier for the client organization

  7. Client Configuration
    • Enter descriptive Client Name • Specify client application identifier

  8. Token Validity Settings
    • Enter "Access Token Validity" in seconds • Set expiration time for generated access tokens • Configure appropriate token lifetime based on security requirements

  9. Refresh Token Configuration
    • Set "Enable Refresh Token" to:

    • True: If refresh token generation needed with access token
    • False: If refresh token not required in response
      • Configure based on application requirements
  10. Refresh Token Validity (if enabled)
    • Add "Refresh Token Validity" in seconds (if Enable Refresh Token = True) • Set expiration time for refresh tokens • Ensure appropriate refresh token lifetime

  11. URL Configuration
    Redirect URL: Enter URL for successful authentication redirect • Error URL: Enter URL for failed token validation redirect • Ensure URLs are accessible and properly configured

  12. Save Configuration
    • Save the enterprise configuration • Complete registration process


📚 Reference Documentation

  • Detailed Information: Refer to REL-ID Gateway Manager Admin Manual
  • Section: Enterprise Management section
  • Purpose: Complete configuration guidelines and advanced options