Organizations and sub-organizations

Organizations, the base grouping of the CloudBees platform, allow users to represent their own access hierarchy. A step below organizations in the hierarchy are sub-organizations, available only to users with a paid subscription plan. Organizations (orgs) and sub-organizations (sub-orgs) are made up of components.

A CloudBees platform tenant org is the default org a user or subscriber to the platform is provided with. For a free plan account, this is the only available org. Each tenant org in the CloudBees platform has an org ID, which is a universally unique identifier (UUID), listed in its Organization profile for use with APIs and OIDC setup.

Users with a paid plan account can create unlimited sub-orgs with complex nesting.

Consider "orgs" and "sub-orgs" to be interchangeable in terms of functionality. Sub-orgs are only designated as such to:

Emphasize that they are not tenant orgs, and have been created by the user.
Assist in understanding the structure of an org hierarchy.

These powerful features ensure that users have access to only configurations they need, reducing cognitive load and improving security.

For example, a top-level org could represent a company or large division, and sub-orgs could represent product teams, with the root nodes representing the individual applications and services being built by those teams.

Figure 1. Example organization with sub-orgs and components.

In the example above, an org () contains multiple sub-orgs () and components (). The indentation indicates the relationships between orgs, sub-orgs, and components.

Table 1. Org, sub-org, and component relationships in the above example.
Item	Direct parent of item	Direct child(ren) of item
Org A	None	Component-1, Sub-org-B, Sub-org-C
Component-1	Org A	None
Sub-org-B	Org A	None
Sub-org-C	Org A	Sub-org-D, Component-3, Component-4
Sub-org-D	Sub-org-C	Component-2
Component-2	Sub-org-D	None
Component-3	Sub-org-C	None
Component-4	Sub-org-C	None

Access an org

Your current org is displayed above the left pane. To be a member of an org, the org administrator must first grant you access.

The tenant organization ID is displayed in the Organization profile.

List orgs

If access to an org has been granted to you, the org is displayed in your org list.

Figure 2. Options to access orgs.

The example above highlights the options for displaying orgs, as explained below:

Select above Home to access a list of other tenant orgs you have been granted access to.
- Filter for a specific org by entering all or part of the name into Search.
- Select an org to make that the current org.
Select below Home to access a listing of the sub-orgs and components within the current org.
- Filter for a specific org, sub-org, or component by entering all or part of the name into Search.
- Select an org or sub-org to make that the current org.
Select an org, and then select Admin settings Organization profile on the upper right by your account name.
- The details of the current org are displayed.
- Select Organizations to display a listing of the sub-orgs within the current org.
Select your account name, and then select User profile.
Select the Organizations tab.
- The orgs you are a member of are displayed, including your role and any teams you are part of.

Inheritance and override rules

A sub-org has visibility into anything declared or visible in the parent org, unless explicitly overridden.

Create a sub-org

The sub-org feature is only available to paid subscription plan users.

To create a sub-org:

Select an org, and then select Admin settings Organization profile on the upper right by your account name.
Select the Organizations tab to the right of Profile.
Perform one of the following options:
- Select Create org.
- Select next to org you want to be the parent org, and then select Create.
(Optional) Select Edit to change the parent org or sub-org.

Figure 3. Editing the parent org with Edit highlighted.
1. Select a new parent org from the list.
2. Select Save.
Enter a Name and optional Description.
Select Create.

The org is created accordingly.

Update an org or sub-org profile

Update the name or description of an org or sub-org, and access the org universally unique identifier (UUID) of the tenant org.

To update an org or sub-org:

Select an org, and then select Admin settings Organization profile on the upper right by your account name.
Select the Organizations tab to the right of Profile.
Select , and then select Edit.
1. Update the Name and/or optional Description.
Select Save.

Your org or sub-org profile is updated accordingly.

Delete a sub-org

A deleted sub-org is completely removed from the CloudBees platform, and deletion is irreversible. All child sub-orgs and components are also deleted.

To delete a sub-org:

Select an org, and then select Admin settings Organization profile on the upper right by your account name.
Select the Organizations tab to the right of Profile.
Select , and then select Delete.
Select Delete.

Your sub-org is deleted, including all of its child sub-orgs and components.