Settings
Portal configuration and branding settings
List all clients in all your tenants
Lists all client registrations for all tenants you have access to.
Create a new client
Creates a new confidential client and returns its credentials. You must
List portals for the authenticated tenant
Returns a paginated list of portals associated with the authenticated tenant.
List the tenants you belong to
Returns a list of all tenants you have access to, including details of your role and permissions.
Create a new tenant.
Creates a new tenant, under which client credentials for API access can be created.
List the options available for clients
Returns the options associated with a client, included the list of scopes that can be granted to a client via
Retrieve a single client in an organisation you belong to
Returns the client's current state. You must be a member of the owning organisation;
Remove a client in a tenant
Marks the client as deleted, blocking all use of the client credentials.
Update a client
Replaces the editable settings of a client: its `clientAlias`, `enabled` status, and `scopes`.
Get portal configuration by slug
Returns the portal configuration for a specific portal by its slug.
Retrieve a single tenant you belong to
Retrieve details of a tenant along with details on your role within it.
List active envelopes for a tenant
Lists the active envelopes owned by the requested tenant's clients, including who
List members of a tenant
Lists the people who belong to the requested tenant, with their email and
Add user to tenant
Add an existing user registered with Onteric to the tenant.
Get an envelope's audit trail
Returns a paginated list of audit events for the envelope, including ACL grants,
Destroy an envelope belonging to a tenant
Permanently destroys the document data held within the envelope.
Remove a member from the tenant
Revokes a member's access to the requested tenant. This operation can only be performed by admin members of the tenant.