Organizations
Invite teammates and guests, manage access and add an extra layer of security for your private APIs with Organizations.
Organizations are great when you need to work collaboratively with your team. Instead of a single shared account, each member of your team will be able to access/maintain your documentation and hubs.
Organizations are also super useful if you want to invite guests (who are called "viewers") to your documentation: it's a read-only role. If you need to keep your API private or shared with a small number of partners, viewers are a great solution.
You can easily create an organization from your dashboard. Select the settings section and the organization tab. From here, you can create an organization or manage the ones you own.
Select "Create Organization" to start a new one. You'll need to name it and choose its slug.
Once your organization is created, you may want to invite teammates and guests (which is the point, actually). When you invite a new member, you'll have to select a role before sending the invitation. Each role has its own permissions, detailed below. Roles can be modified at anytime.
Role/Permission | Admin | Maintainer | Viewer |
|---|---|---|---|
Documentation access | |||
Hubs access | |||
Documentation management | |||
Hubs management | |||
Organization management | |||
Member management |
Adding a new member requires an email address and an assigned role.
Billing and invoice are only managed by the owner of the organization.
From your dashboard, you can manage the organizations you own and those you have admin role. Organization settings allow you to change its name and URL, transfer ownership to an active member or completely delete the organization.
Transferring ownership is mandatory if you want to leave an organization. You can only transfer ownership to a member with admin role.
If you choose to close your Bump account but are still the owner of an organization, a warning message will be displayed. Please consider transferring ownership if necessary.
Deleting an organization will definitively erase its documentation and hubs. We cannot restore deleted content.
The sky is the limit! You can invite as many members as you want to your organizations.
No worries, you can cancel a pending invitation at anytime (or even resend the invitation email).
If the invitation has been accepted, you can still revoke access in a few clicks.
This is most likely due to an organization created during a trial that has not been switched to a paid plan. Organization is a feature available from the Startup plan. If you are in such a situation, please reach us, we'll try to find the most suitable solution for you and your team!
Organizations are a brand new feature we plan to polish with time. We're always open to feedback or suggestions, so please feel free to contact us anytime to discuss what would fit your needs the best.
If you cannot perform this operation on your end yet, we can surely do this for you. Contact us and we will take care of this!
Last modified 8mo ago