Manage Custom Passports in Appspace to update OAuth credentials, control permissions, export configurations, or remove integrations that are no longer needed. The passport edit page provides centralized controls for the full lifecycle of an existing Custom Passport.
- Prerequisites
- View Custom Passport Details
- Update Custom Passport Settings
- Manage Custom Passport Permissions
- Export a Custom Passport
- Delete a Custom Passport
- Related Articles
Prerequisites
Before starting, ensure the following are in place.
- The Appspace user account has the Account Owner, Platform Administrator, or Location Publisher role.
- The Custom Passport already exists in Appspace.
View Custom Passport Details
Follow the instructions below to view the OAuth configuration of an existing Custom Passport.
- Log in to the Appspace console.
- Click Integrations from the ☰ Appspace menu, and click the Passports tab.
- Click the name of the Custom Passport to open the edit page.
- Click the Account Settings tab to view the authentication type, Client ID, authorization URL, token URL, and scopes.
Note
Sensitive values such as the Client Secret are hidden by default on the Account Settings tab. Click the eye icon to reveal or conceal the value.
Update Custom Passport Settings
Follow the instructions below to update the name, description, or OAuth credentials of an existing Custom Passport.
- Open the Custom Passport edit page.
- Click the Account Settings tab.
- Edit the passport name, display name, description, or OAuth credentials.
- Click Save.
Important
Changing OAuth credentials such as Client ID, Client Secret, Authentication URL, or Token URL automatically resets the passport to the Require Authentication state. The OAuth flow must be completed again before the passport can be used.
Manage Custom Passport Permissions
Follow the instructions below to control which users or groups can use a Custom Passport.
- Open the Custom Passport edit page.
- Click the Permissions tab.
- Add or remove users and groups that can use this passport.
- Click Save.
Export a Custom Passport
Follow the instructions below to export a Custom Passport configuration as a JSON file. Exported files can be re-imported into another Appspace environment using Import a Custom Passport from JSON.
- Log in to the Appspace console.
- Click Integrations from the ☰ Appspace menu, and click the Passports tab.
- Locate the Custom Passport in the list.
- Click the ellipsis (⋯) menu next to the passport, and select Export Passport. A JSON file named
<passport-name>-passport.jsondownloads to the local device.
Important
Sensitive values such as Client Secret are cleared from the exported file for security. Recipients must re-enter these values after importing the file.
Delete a Custom Passport
Follow the instructions below to permanently remove a Custom Passport from Appspace.
- Log in to the Appspace console.
- Click Integrations from the ☰ Appspace menu, and click the Passports tab.
- Locate the Custom Passport in the list.
- Click the ellipsis (⋯) menu next to the passport, and select Delete.
- Confirm the deletion.
Related Articles
