Direct Answer: How to Register a Custom App in OnePlan
To register a Custom App in OnePlan, select your profile avatar, choose Register Custom Apps, then select + > New App Registration. Enter the app details, choose a Scope, and select Add. After creation, a Custom App Credentials modal displays the Client ID and (for confidential Custom Apps) the Client Secret — copy both before closing.
What This Article Covers: Register a Custom App
This article explains how to create a new Custom App registration in OnePlan.
What you will accomplish
- Register a new Custom App for an integration
- Choose the appropriate scope for your Custom App
- Copy your Client ID and Client Secret after registration
Before You Begin: Register a Custom App
- You must be a group administrator in OnePlan
- You must be working in the correct group context
- You must have valid Callback URL(s) for your integration
- You should know whether your Custom App is public or confidential
Why This Matters: Register a Custom App
Context: User-Context API Access
Custom Apps enable secure OAuth 2.0 authentication, allowing integrations to access OnePlan APIs using the permissions of the authenticated user.
Context: Scope Controls Availability
The Scope setting determines whether the Custom App is limited to the current group or available for discovery across your organization.
Step-by-Step: Register a Custom App
Task: Open Custom App Registrations
- Select your profile avatar in the top navigation.
- Select Register Custom Apps.
Task: Start a New Custom App Registration
- Select +.
- Select New App Registration.
Task: Enter App Details
In the New App Registration panel, enter:
- Application Name
- Callback URL(s) — enter one URL per line
Task: Choose the Scope
In the Scope field, select how the Custom App will be available:
- Group — the Custom App is available only in the current group. Best for group-specific integrations with dedicated credentials.
- Organization — the Custom App is available across your organization. Other groups can discover and enable it from the Browse App Registrations panel.
Task: Configure App Settings
- Configure optional settings as needed:
- Enable Public client if the Custom App cannot securely store a client secret (requires PKCE)
- Enable Require PKCE to require a PKCE code verifier on token requests
- Select Add.
Task: Copy Credentials
- In the Custom App Credentials modal, copy:
- The Client ID
- The Client Secret (confidential Custom Apps only)
Important: The Client Secret is shown only once and cannot be retrieved later. If the secret is lost, use Rotate secret to generate a new one.
- Select OK.
Frequently Asked Questions: Register a Custom App
What does the Scope setting do in OnePlan?
In OnePlan, the Scope setting controls where a Custom App is available. Group scope limits the Custom App to the current group. Organization scope makes it discoverable by other groups in your organization through the Browse App Registrations panel.
Can I change the Scope after registration?
No. In OnePlan, the Scope cannot be changed after a Custom App registration is created. If you need a different scope, create a new Custom App registration.
What should I do if the Client Secret is lost?
In OnePlan, the Client Secret cannot be retrieved after the Custom App Credentials modal is closed. Use Rotate secret on the Custom App registration to generate a new secret, then update your integration configuration immediately.
Do I need to register a Custom App in every group?
No. In OnePlan, Custom Apps registered with Organization scope can be discovered and enabled by other groups using the Browse App Registrations panel. Each group must add the Custom App individually using Add Consent.
What to Do Next: Register a Custom App
Get started with related tasks
Learn about related topics
Related to
Comments
0 comments
Article is closed for comments.