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 tenant org in the CloudBees platform 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. 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:
|
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-organizations and components. Example component list](_images/example-relationships.c6c8f3d.png)
In the example above, an organization (org, ) contains multiple sub-organizations (sub-orgs,
) and components (
).
The indentation indicates the relationships between orgs, sub-orgs, and components.
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 organization
Your current org is displayed above the left pane. To be a member of an org, the org administrator must first grant you access.
List organizations
If access to an org has been granted to you, the org is displayed in your org list.
![Figure 2. Options to access orgs. Access organization lists](_images/org-lists.e8e74b2.png)
The example above highlights the options for displaying orgs, as explained below:
-
Select the
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 the
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 ADMIN SETTINGS to the left of your account name, then select Organization profile.
-
The details of the current org are displayed.
-
Select ORGANIZATIONS to display a listing of the sub-orgs within the current org.
-
Inheritance and override rules
A sub-org has visibility into anything declared or visible in the parent org, unless explicitly overridden.
Create a sub-organization
The sub-org feature is only available to paid subscription plan users.
To create a sub-org:
-
Select ADMIN SETTINGS to the left of your account name, then select Organization profile.
-
Select the ORGANIZATIONS tab to the right of PROFILE.
-
Perform one of the following options:
-
Select CREATE ORGANIZATION.
-
Select the
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 organization with EDIT highlighted.-
Select a new parent org from the list.
-
Select SAVE.
-
-
Enter a Name and optional Description.
-
Select CREATE.
The organization is created accordingly.
Update an organization or sub-organization profile
Update the name or description of an organization or sub-organization.
To update an organization or sub-organization:
-
Switch to the organization.
-
Select ADMIN SETTINGS to the left of your account name, then select Organization profile.
-
Select the ORGANIZATIONS tab to the right of PROFILE.
-
Select the
, and then select Edit.
-
Update the Name and/or optional Description.
-
-
Select SAVE.
Your organization or sub-organization profile is updated accordingly.
Delete a sub-organization
A deleted sub-organization is completely removed from the CloudBees platform, and deletion is irreversible. All child sub-organizations and components are also deleted.
To delete a sub-organization:
-
Switch to the organization.
-
Select ADMIN SETTINGS to the left of your account name, then select Organization profile.
-
Select the ORGANIZATIONS tab to the right of PROFILE.
-
Select the
, and then select Delete.
-
Select DELETE.
Your sub-organization is deleted, including all of its child sub-organizations and components.