This guide will walk you through the features and functionalities of BCP Organizations, a structure designed to help teams and individuals work efficiently and effectively on GraphQL related services.
What is an Organization
An organization typically represents an entire entity or a larger unit within an entity. Each organization can host multiple workspaces, allowing further categorization and organization of resources. A workspace might correspond to a specific project, a specific team within the organization, or a group of related APIs.
Each BCP user has a personal organization. This is a private space for individual work or for projects that are not associated with any team or company organization. The personal organization is not visible to other users, is created by default and cannot be deleted.
Creating an Organization
BCP allows for multiple organizations under one account. To add a new organization, navigate to the organization switcher in the status bar and click on the "Add Organization" button.
You will be redirected to the management portal. Here you can create a new organization by clicking the 'Create' button.
Each organization has a unique name and a display name which can be set during creation. The name must be lowercase and may only include dashes (-) and underscores (_).
Managing Organizations
To manage your organizations, you have to open the management portal.
In the client app, you can do this by clicking Manage Organizations' and then 'Manage' on the organization that you like to manage.
You can also navigate to here to open the management portal and press 'Manage' on the organization that you like to manage.
Switching Organizations
In Banana Cake Pop, you can be signed into multiple organizations at the same time and switch between them in the status bar. The organization switcher also allows you to create new organizations.
Managing Members
The count of members and the number of seats available in your subscription are displayed in the management overview section. (members/total seats)
This list show all the members of the organization and their role.
Members can be invited to join an organization via email. In the management overview section, the 'Invite User' button allows you to send an invitation email containing a join link.
Open invitations are displayed below. You can revoke an invitation by clicking on the 'Cancel' button. Once an invitation is expired, you can resend it by clicking on the 'Resend' button.
Joining an Organization
Invited users can join an organization in two ways:
- By clicking on the join link they received via email.
- By opting to join during login on the sign in page.
During sign-in, the user can select into which organization (join orgs or personal) they want to sign in.
[Description of visualization: Screenshot showing the organization selection during sign-in]
User Roles and Access
There are three distinct roles within an organization: Owner, Admin, and Collaborator. Each role carries specific permissions:
| Role | Transfer Ownership | Delete Organization | Invite Users | View Subscriptions | Add Redirect URLs |
|---|---|---|---|---|---|
| Owner | Yes | Yes | Yes | Yes | Yes |
| Admin | No | No | Yes | Yes | Yes |
| Collaborator | No | No | No | No | No |
Owner: The owner can transfer ownership, delete the organization, and has all the permissions of an admin. Each organization can only have one owner.
Admin: Admins can invite users to the organization, view subscriptions, and add redirect URLs. They also have all the permissions of a collaborator.
Collaborator: Collaborators can log into the organization and leave the organization. They cannot add redirect URLs or invite new users.
Managing Permissions
You can manage the permissions of each member in the member list.
Press the 'Edit' button on the right side of the member list to open the edit dialog.
Select the desired role for the member.
Press the 'Save' button to save the changes.
You can also remove a member from the organization by clicking on the 'Revoke Access' button.
Transferring Ownership
Ownership of the organization can be transferred to any existing member from the management portal.
In the danger zone section, click on the 'Transfer Ownership' button to open the transfer dialog.
Redirect URLs
Each time a user signs into an organization from a new origin, a redirect URL must be added to the organization.
This security measure is designed to prevent your access tokens from being leaked to any arbitrary site hosted by third parties.
If the user is a collaborator, they won't have the permissions to add the URL and will see an informative message. An admin, on the other hand, can directly add the URL to the organization.
You can add the redirect URL in two ways:
- By signing in from the new origin. This will trigger a prompt to add the URL to the organization.
- By adding the URL directly from the management portal.
In the portal you have more options to configure the allowed destinations. You can for example allow all localhost origins. Or disable the access to the web UI in the cloud
- Configure the allowed types of origins.
- Add redirect Urls to the organization.
- Remove redirect Urls from the organization.