Flexpa Portal
Flexpa Portal is an interface designed for developers to manage and provision their test and live mode applications.
You can use the portal to create and manage your applications, set up billing details, and apply for live mode.
Your team can sign up at portal.flexpa.com to create a Flexpa Portal workspace and invite all colleagues to collaborate.
See below for an overview of the functionality available in Flexpa Portal.
#Home
Flexpa Portal's homepage guides you through the steps required to get up and running with Flexpa in first Test Mode and then
Live Mode. Each step includes additional documentation to reference, or pointers to the correct tabs in Portal to complete
the step.
#Profile
Your profile page is simple at the moment, just a place for you to change your display name and password.
#Access token logs
Flexpa Portal provides detailed logs of all patient access tokens generated by your application to aid in troubleshooting
and grant insights into user behaviors. This page displays information about each time Flexpa Consent has been opened in
live mode within your application. You can see data like the access token state, the connected endpoint,
and any associated error messages.
#Applications
This tab is where you will self-service creation and access to your application's API keys.
Test mode application keys are available to be generated or rotated anytime.
Live mode keys are made available after completing the required steps laid out on the homepage.
These steps include filling out a Live Mode Access form, as well as providing payment details via Stripe.
You can create and manage your test and live mode applications, and view your application keys.
#Live mode access
Once you are ready to go live, you can apply for live mode and complete the steps in Go-live checklist.
The Live Mode Access form is a short form detailing more information about your organization.
Flexpa administrators will review your application once complete and you will receive an email notification once your application is approved. This step is necessary to proceed with generating Live Mode keys.
#Payments & Billing
This tab will take you out to Stripe, where you will fill in payment details.
This step is necessary to proceed with generating Live Mode keys.
#Roles & permissions
Flexpa Portal uses role-based access control to manage what workspace members can do. Each member is assigned a role that determines their permissions across the workspace.
There are two roles:
- Admin — Full access to all workspace functionality including team management and live mode API keys.
- Member — Access to most workspace functionality except team management and live mode API key management.
The user who creates a workspace is automatically assigned the admin role. New members invited to a workspace are assigned the member role by default.
Admins can change any member's role at any time from the Team page in Flexpa Portal.
#Permissions
| Permission | Code | Description | Admin | Member |
|---|
| View team | team:read | View workspace members and their roles | ✓ | ✓ |
| Team management | team:manage | Invite, remove, and change roles of workspace members | ✓ | |
| Live mode API keys | api-keys-live:manage | Create, rotate, and manage live mode application keys | ✓ | |
| Test mode API keys | api-keys-test:manage | Create, rotate, and manage test mode application keys | ✓ | ✓ |
| View API keys | api-keys:read | View existing API keys for all applications | ✓ | ✓ |
| SSO configuration | sso:manage | Configure SAML-based single sign-on for the workspace | ✓ | |
| Analytics | analytics:read | View access token logs and usage analytics | ✓ | ✓ |
| PHI access | phi:read | View protected health information in access token logs | ✓ | ✓ |
| Billing | billing:manage | Manage payment details and view invoices via Stripe | ✓ | |
| View settings | settings:read | View workspace settings | ✓ | ✓ |
| Manage settings | settings:manage | Update workspace settings | ✓ | ✓ |
The phi:read permission is granted to all workspace members by default. This provides minimum necessary access to PHI in access token logs for troubleshooting purposes. Be mindful when inviting new members that they will have visibility into PHI present in logs.
#Managing team members
Admins can manage their team from the Team tab in Flexpa Portal.
Inviting members — Admins can invite new members by email. Invited users receive an email with a link to join the workspace. New members are assigned the member role by default.
Changing roles — Admins can promote a member to admin or demote an admin to member from the team page.
Removing members — Admins can remove any member from the workspace except themselves.