Definition and capabilities of the Penneo Super API user
The Penneo Super API user is a specialized user role with both limited and expanded rights designed to provide account-wide control for integrations, specifically regarding access to signed documents. This role is created to give organizations more control over specific aspects of a Penneo integration.
Account-wide data access for Super API users
Penneo Super API users have expanded rights that allow them to access all casefiles and documents across the entire account, regardless of whether those items were sent by or shared with the user. While other user roles only access content they created or had shared with them, the Super API user provides a comprehensive, holistic view of all Penneo documents and data, making it the ideal role for system-wide integrations.
Limitations and restrictions of the Super API role
The Penneo Super API user role is subject to specific restrictions to ensure system integrity. Users in this role can only access Penneo through the API and cannot log in to the web application or archive. Additionally, Super API users cannot create or send casefiles for signature. Once created, a Super API user cannot be converted into a regular user or administrator; the role and its rights remain fixed.
Creating a Penneo Super API user
Follow these steps to create a Super API user within the Penneo company configuration:
- Navigate to the user overview under company configuration.
- Click 'Create a new user’.
- Provide a name and email address for the user.
- Select ‘Super API user’ for the role. Note that API Keys are automatically enforced as the only available login method.
- Click 'Create user’. Note that an invitation email is not sent for this user role.
- Copy the API key and secret immediately, as they will not be displayed again.
It is critical to copy the credentials during the final step of the creation process. You will not receive an email invitation containing these credentials, and they cannot be retrieved after the window is closed.
Resetting Penneo API credentials
If API keys are lost or need to be replaced, administrators can reset the credentials for a Penneo Super API user. Be aware that any integration using the old keys will stop working immediately upon the credential reset.
- Navigate to the user overview and find the Super API user in the user list.
- Select the option to edit the user.
- Choose to reset the credentials.
New API keys will be generated and displayed once. You must copy and save these keys immediately, as they will not be accessible once the window is closed.
Deleting a Super API user
Penneo administrators can delete a Super API user in the same manner as other user types. Detailed instructions for this process can be found in this guide: Administrator Basic Setup Resources.
Deleting the user immediately deactivates the associated API key and secret. Any integration relying on these credentials will cease to function right away.