Organization Permissions
An Organization is the top-level resource under which all other resources exist.
Functionalities:
- User management
- Invite users
- Remove users
- Alter user’s Organization role
- Doc/API Project creation
- Global settings
- Default Doc Project generation theming/config
- Default API Project code generation config
- Audit log export
| Resource | Role | Description |
|---|---|---|
| Organization | Admin | Full access to all Organization configurations including user invites/removals, organization role assignment, billing, etc. Automatic Admin role assignment on all Doc & API Projects |
| Organization | Manager | Can update limited organization settings. Can create new Doc & API Projects |
| Organization | Member | No organization permissions, simply a member |
Project Permissions
API Projects and Documentation Projects are resources that are owned by an organization.
API Project
An API Project maps one-to-one with an API service. It is the centralized place to upload versioned OpenAPI specifications for a given service and enables Sideko’s Documentation generator, SDK code generator, testing, and publishing capabilities.
Who should have access?
This is primarily a space for engineers and other technical staff members. Technical writers need also need read access to API projects in order to link them to documentation projects.
Documentation Project
A Documentation Project represents a single website that Sideko will generate.
Who should have access?
Technical writers, developer experience, and technical partnership.
| Resource | Role | Description |
|---|---|---|
| Doc Project | Admin | Full read/write access to Doc Project’s settings & versions. Can manage user access/roles to Doc Project. Can publish documentation to Preview & Production |
| Doc Project | Contributor | Can read/write to Doc Project’s versions (e.g. linking API Projects, guide content, site metadata, etc.) |
| Doc Project | Viewer | Read-only access |
| API Project | Admin | Full read/write access to API Project’s settings & versions. Can manage user access/roles to API Project |
| API Project | Contributor | Can read/write to API Project’s versions (e.g. renaming, uploading new/updated OpenAPI specification, etc.) |
| API Project | Viewer | Read-only access |