Introduction
Organizations and Groups in ApiShare define the hierarchical structure that governs API and application ownership, visibility, and user management. Organizations can be either internal (for in-company collaboration) or external (for partner integration). Each organization consists of multiple Groups, which contain users with assigned roles. Groups ensure controlled access and management within an organization.
Managing organizations
Creating an organization
Prerequisites:
Requires ApiShare Tenant Administrator permissions.
Organization details (name, contact email, description) must be prepared.
Steps:
Navigate to the Organization section in the ApiShare main menu.
Click on Add to create a new organization.
Enter the required details:
Name: Unique identifier for the organization.
Organization Contact: Default email for organization-related communications.
Description: A brief summary of the organization's purpose.
Once all mandatory fields are completed, the ADD button becomes active. Click it to confirm creation.
Post-Conditions:
A new organization is registered in ApiShare.
If the organization is internal, ApiShare automatically creates an Org Admin Group.
Tips:
If the tenant is set to automatic synchronization mode, the organization will also be created in the API Gateway.
Editing an organization
Prerequisites:
Requires Tenant Administrator or Org Admin permissions.
Steps:
In the Organization section, locate the organization to edit.
Click on Edit next to the selected organization.
Modify the necessary details (name, contact, description).
Click EDIT to confirm the changes.
Post-Conditions:
The organization details are updated in ApiShare.
If automatic synchronization mode is enabled, the changes will be reflected in the API Gateway.
Tips:
Members of external organizations cannot belong to multiple internal organizations simultaneously. If this condition is violated, an error message will be displayed.
Deleting an Organization
Prerequisites:
Only Tenant Administrators and Org Admins can delete an organization.
No APIs or applications should be associated with the organization.
Steps:
Navigate to the Organization section in ApiShare.
Click Delete next to the target organization.
Confirm the action in the pop-up window.
Post-Conditions:
The organization, along with all its groups and users, is permanently removed.
If automatic synchronization mode is enabled, the organization will also be removed from the API Gateway.
Tips:
Ensure all associated entities (APIs and applications) are reassigned before deletion.
Searching for an organization
Steps:
In the Organization section, use the search bar.
Search by name, or use filters:
By Group: Lists organizations containing a specific group.
By User: Lists organizations associated with a specific user.
Post-Conditions:
The search results display relevant organizations based on the selected criteria.
Requesting to join an organization
Steps:
Navigate to the Organization section in ApiShare.
Click on the Join icon in the top-right corner.
Select the desired organization(s) and click JOIN.
Post-Conditions:
A join request is sent to the organization's administrators for approval.
The request status can be monitored in Join Requests > Sent.
Managing join requests
Prerequisites:
Requires Org Admin or equivalent permissions.
Steps:
Go to Join Requests > Received in the Organization section.
Locate the request and choose one of the following:
Approve: Assign the user a group and role, then confirm.
Reject: Deny the request, and it will be marked as rejected.
Post-Conditions:
If approved, the user gains access to the organization based on the assigned group and role.
If rejected, the request remains in the Rejected state.
Managing groups
Creating a group
Prerequisites:
Requires Org Admin or Group Admin permissions.
Steps:
Navigate to the Organization section.
Select the organization where the group will be created.
Click Add and enter the required details:
Name: Unique identifier for the group.
Group Contact: Default email for group communications.
Description: Brief explanation of the group's purpose.
Click ADD to finalize creation.
Post-Conditions:
A new group is registered under the selected organization.
Editing a group
Prerequisites:
Requires Org Admin or Group Admin permissions.
Steps:
In the Organization section, locate the group to be edited.
Click Edit next to the group.
Modify the necessary details (name, contact, description).
Click EDIT to save changes.
Post-Conditions:
Group details are successfully updated.
Deleting a group
Prerequisites:
Requires Org Admin or Group Admin permissions.
The group must not contain any APIs or applications.
Steps:
Navigate to the Organization section.
Select the organization containing the group.
Click Delete next to the group and confirm the action.
Post-Conditions:
The group is permanently removed.
Tips:
The Org Admin Group cannot be deleted unless the entire organization is deleted.
Adding a user to a group
Prerequisites:
Requires Org Admin or Group Admin permissions.
The user must be registered in ApiShare.
Steps:
Navigate to the Organization section.
Select the organization and group.
Click Add Users and choose one of the following:
Search and select an existing user.
Enter an email to invite a new user.
Assign a role and confirm the addition.
Post-Conditions:
The user is successfully added to the group and inherits the assigned role.
Removing a user from a roup
Prerequisites:
Requires Org Admin or Group Admin permissions.
Steps:
Navigate to the Organization section.
Select the organization and group.
Locate the user and click Remove.
Confirm the action.
Post-Conditions:
The user no longer has access to the group.
Any APIs or applications they owned must be reassigned.
Viewing users in a group
Steps:
Navigate to the Organization section.
Select the organization and group.
Browse the user list or search for a specific user.
Post-Conditions:
Displays all users within the selected group.
Clicking on a user provides a detailed overview of their roles and permissions.