The Workspace API has no public address yet. Connect a Provider from
Providers in the Workspace app. See
Availability.
Create a connection
Choose a Provider Plugin and grouping from the Provider Directory, then create the Workspace connection:authenticationConfig from the selected strategy’s configSchema.
Build ingestionConfig from the plugin’s ingestionConfigSchema when one is
present. The latter supplies connection-specific values such as an organization
identifier or instance host; it does not redefine the plugin’s traversal or
pagination behavior.
After the Workspace app saves the connection, it opens that connection’s setup
page and shows credential validation progress. Saving a connection does not mean
its credentials have passed validation; any validation error appears on that page.
The setup page opens on the connection’s configuration form. Its rail lists the
Provider’s Overview, Setup Guide, and Troubleshooting. While one of
those is open, Edit connection below them returns to the form. A user who
may not change the connection sees View connection there instead, which
returns to the read-only form.
When the stored credentials are unvalidated or invalid, the status notice on
the setup page offers Check again, whatever the notice says about the
connection. An unvalidated credential is eligible to sync, so the notice can
report a running sync while no check has judged the credential. Check again
runs POST /api/connectors/validate on the credentials already stored for the
connection, so a fix on Parable’s side, such as a new validation endpoint or
credential check for the Provider, can change the verdict without re-entering
secrets. The setup page reads the credential id from the stored connection,
requires permission to configure connectors, shows the verdict the check stored
with its message, and then refreshes the connection status.
When the strategy authorizes through the Provider’s OAuth consent screen, the
setup page sends the user there. After Parable exchanges the authorization code,
the user returns to the same setup page, which shows validation progress.
Read connection state
The instance reports computed fields such as connection status, credential validity, and recent sync state. Use the Provider Directory instance operations to list all connections or fetch one by ID.Reconfigure or remove a connection
POST /api/connectors/configurereplaces connection configuration or credentials using a supported authentication strategy.DELETE /api/connectors/{tenantConnectorId}removes the Workspace’s connection.- The configuration-history operation shows prior configuration attempts without returning secret values.
Who can create or change a connection
The Workspace app offers a control only when the Workspace API would accept the operation behind it. Both read the permissions declared on the operation:
A permission covers its children.
tenant.connectors and the Workspace
Administrator’s tenant cover both Workspace permissions; staff admin and
admin.tenant cover admin.tenant.connectors. A staff role also passes
through the staff copy of the Workspace permission, such as
admin.tenant.connectors.secrets. tenant.connectors.edit alone does not
allow saving a connection.
A user who can view connections but cannot change them sees the setup page
read-only, with a View only notice; the create page does the same for a
user who cannot create. Staff browsing Providers without a Workspace see the
create page as a preview and get no New connection link, because a
connection belongs to a Workspace.
See Provider authentication
for credential handling and
data streams for per-stream
controls.