Project Management
Overviewβ
Project Management in the Tenant Manager Console allows administrators to create, edit, and manage API-related or Developer Portal-related projects. Each project is associated with a specific gateway type and has its own set of assigned users with role-based access. This guide walks through the available actions and screen functionality.
In APIM, projects are displayed in two types:
- type: apim β This represents the concept of an internal organization/team for API development within the APIM Console and is displayed as "Project" in the APIM Console.
- type: developers β This represents "Application" or "My Application" for general users to develop within the Developers Portal.
Project List Screenβ
Purposeβ
This is the main screen where users can view all existing projects, including their type, gateway, creator, and creation date.
User Actionsβ
- View project list: All projects are listed in a paginated table.
- Search: Enter two or more characters to filter the list by project name.
- Create new project: Click the button to add new project.
- Edit: Click the pencil icon button to view and update a project.
- Delete: Click the red trash icon button to remove a project.
Create New Projectβ
Purposeβ
This screen allows the creation of a new project by specifying its basic attributes.
Fieldsβ
- Project Name: Input field for the name of the project.
- Project Type: Dropdown to select either apim or developers.
- Gateway Type: Dropdown to choose between kong or aws.
User Actionsβ
Fill out the form and click submit button to create a project.
Edit Project & Project User Managementβ
Purposeβ
After creating a project, you can edit its properties and manage its users in the detail view.
Fieldsβ
All fields are read-only except for project name
- Project Name
- Project Type
- Gateway Type
- Created At
- Created By
Project User Management Sectionβ
This section shows a list of users assigned to the project.
User Actions:
- Add User to Project: Click plus button to open the user selection dialog.
- Modify User Role: Click the blue badge icon button to assign roles.
- Remove User: Click the red trash icon button to remove the user from the project.
Change User Role in Projectβ
Purposeβ
Allows assigning user roles within a project for access control.
Roles Availableβ
- apim-pjt-admin: APIM Project Admin (has full access)
- apim-pjt-member: APIM Project Member (limited access)
User Actionsβ
Select a role for the user.
Click save change button to apply the new role(s).
Add User to Project (User Search)β
Purposeβ
Displays a list of all system users to be added to the project.
User Actionsβ
- Search by keyword to filter the user list.
- Select one or more users using the checkboxes.
- Click add project user button to assign role for the selected users to the project
- Submit the role assigning modal to finish adding the users to the project
Remove User from Projectβ
Purposeβ
Confirmation popup to remove a user from the project.
Message Displayedβ
- Confirmation that the user will be removed from the specified project.
- Action options: Cancel, Confirm
Delete Projectβ
Purposeβ
Confirmation popup to delete an entire project.
Message Displayedβ
- Warning that all project resources (Gateway, API, etc.) will also be deleted.
- Action options: Cancel, Confirm