Roles and visibility
API-dex shows menu items based on your role and on which modules the organisation has enabled. Background is in Roles and types of users and Visibility. This page is the exact matrix. Where the main navigation sits is a property of the portal, not the role; see Portal layout.
Main navigation
| Item | Shown to |
|---|---|
| Home | Everyone |
| Documentation | Everyone, once a documentation tree is published |
| APIs | Everyone |
| My Applications | Everyone. Administrators see every application in the environment; other users see their own and those shared with their teams |
| My Teams | Everyone |
| My Analytics | Administrators and business analysts, from the profile menu |
| Companies | Subscription managers, where company and subscription management is enabled |
| Admin | Administrators. Contains Permission Groups, Logging, Pending Approvals and Environments |
Team details tabs
| Tab | Shown to |
|---|---|
| Members | Everyone with access to the team |
| Permission Groups | Administrators |
| APIs | Everyone with access to a backend team |
| Applications | Everyone with access to a consumer team |
| Settings | Everyone with access to the team |
API page menu
| Item | Shown to |
|---|---|
| Download spec, Compare versions | Everyone |
| Analyze Spec, Assign to backend team, Reassign to another backend team, Delete specs | Administrators and producing roles |
Settings and organisation tools
| Item | Shown to |
|---|---|
| Organisation Settings | Administrators |
| Narrow strip (internal portal) | Everyone, when the deployment enables more than one major area (for example Developer Portal plus Data Dictionary) |
Role summary
| Role | Can do |
|---|---|
| Signed-in user | Open Home, Documentation, APIs, My Applications and My Teams; request access to APIs for their applications; manage team membership within the team's roles; read specifications |
| Administrator | Everything a signed-in user can, plus the Admin area (approvals, logging, permission groups, environments), organisation Settings, every application in the environment, the Permission Groups tab on team details and the producer items in the API page menu |
| CI/CD | Publishes specifications with the API-dex CLI; in the browser, sees the upload area on the APIs page and a different empty state when no APIs exist |
| Subscription manager | Sees Companies where enabled. Opens My Analytics only when also holding an analytics role |
| Business analyst | Sees My Analytics |
First-time setup
On a new installation, the first administrator is taken through a create-environment wizard before the full portal opens.