This guide explains how to generate the credentials your integration needs to authenticate via the OAuth 2.0 protocol.
Â
đź“„ Overview
âś… Prerequisites
⚙️ Step-by-Step Configuration
đź”’ Security Warning: Credentials
Â
Overview
To interact with Penneo's API securely, your application must identify itself using an OAuth Client. This ensures that data remains protected while allowing your integration to perform actions on behalf of a user.
Prerequisites
Before you begin, make sure you meet the following requirements:
- Role: You must have Administrator permissions on the Penneo account.
- Access: You must be able to log in to the Penneo Web Application.
Step-by-Step Configuration
- Log in to Penneo: Log in to the Penneo web application. Make sure you're logged into the correct account where you have administrative rights.
- Navigate to OAuth Clients: In the main navigation menu, go to Configure and select OAuth Clients.
- Create a new client: Click the Create new client button to begin the generation process.
-
Configure client details: Enter your application name and specify your
redirect_uris. You can update the redirect URIs at any time, but the client name should clearly describe your integration.
Security Warning: Credentials
Immediate action required: Store your
client_idandclient_secretin a secure vault (e.g., Azure Key Vault, 1Password) immediately after creation.
- The
client_secretwill only be displayed once. If lost, you will need to delete the client and create a new one.- The
redirect_uriscan be updated later if your callback URLs change.