Prerequisites
As prerequisites you will need the following:- Access to your PingFederate instance
- Administrator permissions on PingFederate to create and configure OAuth clients
- Understanding of your organization’s authentication flow requirements
Create an OAuth Client
The OAuth client allows you to integrate with Ona using the OpenID Connect protocol. Please refer to the official PingFederate documentation for detailed configuration steps.- Log in to your PingFederate Administrative Console.
- Navigate to Applications > OAuth > Clients.
- Click Add Client to create a new OAuth client.
-
Configure the OAuth client with the following settings:
- Client ID: Generate or specify a unique identifier (you’ll need this for Ona)
- Client Authentication: Select
Client Secret
- Client Secret: Generate a secure secret (you’ll need this for Ona)
- Allowed Grant Types: Select
Authorization Code
- Redirect URIs:
https://app.gitpod.io/auth/oidc/callback
- Allowed Scopes: Include at minimum:
openid
profile
email
-
Configure Token Settings:
- Set appropriate token lifetimes based on your security policies
- Ensure ID tokens include necessary claims (
sub
,email
,name
)
-
Save the Configuration and note down:
- Client ID: The unique identifier you specified
- Client Secret: The generated secret
- Issuer URL: Your PingFederate base URL (e.g.,
https://your-pingfederate.company.com
)
Additional Configuration
Depending on your PingFederate setup, you may need to:- Configure attribute mapping to ensure user information (email, name) is properly passed to Ona
- Set up any required authentication policies or adapters
- Configure session management settings
- Review and adjust any security policies that might affect the integration
Troubleshooting
Common issues and solutions:- Invalid Redirect URI: Ensure the redirect URI in PingFederate exactly matches
https://app.gitpod.io/auth/oidc/callback
- Missing Claims: Verify that your PingFederate configuration includes the required OpenID Connect claims (
sub
,email
,profile
) - Authentication Failures: Check PingFederate logs for detailed error information