Introduction
Target audience
This document is addressed towards Administrators who will oversee the adoption and configuration of the Platform.
Document scope
This document describes all the administrative configurations that can be performed by special users of the Platform with the Owner role directly from the Platform front-end.
(Some of the configurations documented can be performed by other users with the required permissions: configurations such as widget editing in the home page, or Group and User management in the Organizations section.)
The installation of the Platform and the configuration of its infrastructure are not part of this document.
THE CONFIGURATIONS DESCRIBED HERE SHOULD BE CHANGED WITH A CLEAR UNDERSTANDING OF THE POSSIBLE IMPACTS ON THE PLATFORM ECOSYSTEM, AS CHANGES MAY IMPACT THE VISIBLE DATA AS WELL AS THE OPERATING MODEL FOR ONE OR MORE USERS.
IT IS RECOMMENDED FOR ADMINISTRATORS TO ALSO KEEP THEIR CUSTOMER SUCCESS REPRESENTATIVE INFORMED OF ANY SUCH CHANGES.
The Administration section
Most of the configurations described in this document can be found from the sidebar menu, under Administration. The Administration section is reserved to the Owner and its overview groups the configurations in five areas:
Area | Entries | Described in chapter |
|---|---|---|
Classification & Taxonomy | Digital Product Types, Tags, Categories (API, App, Organization, Documentation), Integration Patterns | Classification and taxonomy |
Access Management | Roles, Visibility, Profiling | Organizations and users (Roles), Default entity visibility (Visibility), Stakeholder profiling and features (Profiling) |
Security Governance | Keyset policy templates, Subscriptions Lifecycle | Security governance |
System | General, Documentation, SMTP | System |
Notifications | Notifications | Notifications |
The other configurations are performed outside the Administration section, by users with the necessary permissions:
organizations, groups, users, join requests and invitations, in the Organizations section of the sidebar (see chapter Organizations and users);
the widgets of the home page, directly in the Home page (see chapter Branding and customization).
NOTE: There is no dedicated entry for the Network (the client IP addresses that applications declare when they subscribe to APIs). Its administration goes through Roles (the permissions on IP addresses), Profiling (the Network area and the IP field in subscriptions) and Notifications (the IP address entity). These settings are described in the related chapters.
NOTE: The sidebar of the Owner can also show the AI Tools section, with Discovery AI: an AI assistant that helps to search and explore the contents of the Platform. It is available only if enabled for your installation.
How the configurations work together
What a user can see and do in the Platform results from the combination of three configurations, all managed from the Administration section:
Role: the actions that the user can perform on each entity and in each environment. A user has a role in each organization they belong to (see chapter Organizations and users).
Stakeholder type (Internal, External, Guest, Visitor): for each type, Profiling defines which sections, features, filters and columns are available (see chapter Stakeholder profiling and features).
Visibility: which digital products and documents each user can see in the catalogs. The defaults are set in Visibility and can be overridden on each digital product or document (see chapter Default entity visibility).
For example, a user can subscribe to an API only if the API is visible to them, if subscriptions are enabled for their stakeholder type and if their role allows them to subscribe in the chosen environment.
The stakeholder type depends on the organization the user belongs to:
Stakeholder type | Who they are |
|---|---|
Internal | Users who belong to Internal organizations. They are involved in the end-to-end governance of the entities of the Platform (digital products, applications…). |
External | Users who belong to Partner or Citizen organizations. In other words, external users who have been onboarded onto the Platform, generally to consume digital products or consult the catalogs. |
Guest | Users who have registered on the Platform but have not been onboarded on any organization. |
Visitor | Users who have not logged into the Platform. NOTE: This applies only if the Public Showcase is enabled for your installation. |
These settings can be changed in real time from the Administration section, based on contract details and/or your preferences.
NOTE: Some features are available only if enabled for your installation: for example AI assistants, Assets, digital products other than APIs (such as MCP servers and AI Agents), the Public Showcase and the integrations with API gateways. When a feature is not enabled, the related settings are not shown or are shown as unavailable.
Configurations with impacts on other entities
Some configurations have effects beyond the page where they are set. They are highlighted with IMPACT in each chapter; the main ones are:
Roles and notifications: when a role is created, the notifications for that role should also be reviewed.
Approval steps and permissions: if a subscription approval step is enabled, some roles must have the permission to approve subscriptions in that step.
Tags, categories and keyset policies: the rules of keyset policy templates can be based on the tags and categories of APIs; deleting a tag or a category can change the scope of a policy.
Organization categories and visibility: categories can be used to extend visibility and automatic approvals to whole groups of organizations.
Non-retroactive settings: several settings apply only to what is created after the change (keyset policy templates, subscriptions lifecycle, invitation expiration, documentation versions limit, integration patterns).