Skip to content

Manage organizations#

An organization allows you to collaborate with others on a shared set of Protobuf files. Once you've set up the organization, you can add other Buf users as members and assign roles to them. Depending on the role, they may have specific permissions to change the organization itself and the underlying resources.

Create an organization#

To create a new organization:

  1. Sign in to the Buf Schema Registry.
  2. Click on Show all under the Your organization section.

  3. Select Create Organization.

    Create a new organization

When setting up a new organization, there are a few important things to keep in mind:

  • The organization name must be unique and between 3 and 32 characters in length. It can only contain lowercase letters, numbers, or hyphens (-).
  • You can add an organization URL in the repository settings later.
  • You can also provide a description of the organization, which can be up to 350 characters in length, and provide an organization logo to make the org memorable and identifiable.

Warning

Organization names can't be changed without deleting and recreating the organization and all of its contents. Choose the name carefully.

Delete an organization#

Deleting the organization is a permanent action, and can't be undone. You must first delete all repositories and plugins owned by the organization.

Manage organization membership#

BSR users can be members of both organizations and repositories, and have access to each based on their role.

This section describes how to manage organization members using the BSR web app. See Manage user access with IdP groups if you're using IdP groups to manage organization membership.

Add a member#

Organization members with the Owner or Admin role can add and edit members. When adding a member to an organization, keep in mind:

  • The member must already have an active Buf account.
  • Once added, the member has the organization's base resource role for each resource type unless given higher access.

To add a member:

  1. Go to the organization's Members page at https://buf.build/ORGANIZATION/members
  2. Select Add member.
  3. Search for the user by username and choose their role.
  4. Click Submit.

Change member access#

To change a member's access level:

  1. Go to the organization's Members page at https://buf.build/ORGANIZATION/members
  2. Click on the settings icon for the member and choose Change role.
  3. Choose the role to apply.
  4. Confirm the operation.

If you're using an IdP group to manage membership in the organization, the member's role can't be set lower than the default role set for the IdP group.

Remove a member#

You may need to manually remove a member from a BSR organization—for example, if you're not managing members via SAML or SSO and a user's credentials are compromised or they leave the company. The organization must always have at least one Owner.

To remove a member:

  1. Go to the organization's Members page at https://buf.build/ORGANIZATION/members
  2. Click on the settings icon for the user and choose Remove user.
  3. Confirm the removal.

If you're on a private BSR instance, you also need to deactivate the user:

  1. Go to the BSR instance user directory at https://buf.build/admin/users
  2. Click the options button for the user and select Deactivate User.
  3. Confirm the deactivation.