Let’s begin with the configuration:
- To begin configuring your Provider Organization, you must be logged into the Cloud Manager UI. Once logged in, you should be at the home screen where you need to click the Manage Organizations icon as shown in Figure 3.3:
Figure 3.3 – Cloud Manager UI home screen
2. You should now see a screen that would show you all of your configured organizations. Since you don’t have any yet, this list should be empty so you will need to add one. From this screen, in the top-right corner, you will see an Add button where you will click Add | Create organization.
3. This will bring you to a screen where you will enter all of the required information for your new Provider Organization.
4. The first field you will enter is the Title for your organization. This will be the name you will see when you view your existing Provider Organizations as well as the name that will be seen within the portal where your APIs will be discovered. For our example, we will create a fictitious healthcare Provider Organization with the title APIC Healthcare.
5. Once a value for Title is entered, you will see that the Name field will auto-populate with a slugified representation of the Title field. This means it is converted to lower case and spaces are replaced with the – character. For our example, our APIC Healthcare title was converted to apic-healthcare. This value will be used in the URL to access the Developer Portal and invoke APIs within this organization as well as to identify your organization within the Developer Toolkit CLI.
6. The next section, which will complete your Provider Organization configuration, will be to define the Owner of the organization. The owner of the organization will be the administrator of the organization who will have the authority to invite new members to the organization, author APIs and products, and manage the API and product life cycle. To set the organization owner, you have two possible options: you can select an existing user in one of the registries configured within the Cloud Manager, or you can add a new user to one of these pre-defined registries.
All of your pre-defined public registries will be listed in the User registry field within a dropdown.
Info:
User registries have visibility. When the cloud administrator sets a user registry to private, that user registry will not be available when creating a new Provider Organization.
One of these must be selected before entering the owner’s user ID. An important thing to note here is that once your Provider Organization is created, you cannot change this value to a different user registry.
7. Once the registry is selected, you can specify whether you will use an existing user from the registry selected, or you wish to add a new user. This will be specified via the radio button for the field Type of user. If you are using an existing user, you must specify the username in the Username field. If this is a new user to be added, you will see one additional field, Email, where you will enter the new user’s email address in addition to Username, First name, Last name, and Password.
8. Once the organization title and the organization owner are set, you can click the Create button to create your organization. Figure 3.4 shows our new Provider Organization, APIC Healthcare, being created. You can see that Title had spaces so Name was autogenerated as the title was transposed to all lower case and spaces were replaced with -. In this example, we chose to create a new user within our existing registry as the Provider Organization owner so we selected New User from the Type of User field and filled out the appropriate details:
Figure 3.4 – Create new Provider Organization
9. Once you complete the new Provider Organization step and click the Create button, a new user is entered into the specified registry and a new Provider Organization is created. You will be brought back to the Provider Organizations screen, where you will see a message indicating that your new Provider Organization has been created also indicating the owner that has been assigned. You can see in Figure 3.5 that our example Provider Organization was created and now appears in the list of Provider Organizations:
Figure 3.5 – New Provider Organization created
Congratulations! You have now created your Provider Organization, which will be the foundation for all other components that you will define within it. The owner of this organization can now invite other users to the organization and move on to the next step of the process, which is to create the Catalog(s) within the organization.