Roles
In Apinizer, it is not possible for a user to access a project they do not have permission for, or even perform an action that is not within their authority within the same project. Users need to have role/roles to perform operations in any project.
When the system is first installed, seven API roles (Project Owner, API Developer, API Manager, API Creator, API Security, API Analytics, API Tester) and four AI roles (AI Admin, AI Developer, AI Analytics, AI Finance) come ready. Default roles can be used to authorize users or teams, or new roles can be defined.
These roles and the permissions of the roles are explained in detail below:
Default Roles and Permissions
The permissions below are the defaults created on a new installation. For the full list of each role's permissions by category and action, see Role Permission Details.
| Role | Description | Main Permissions (Manage) |
|---|---|---|
| Project Owner | Role with all permissions in the project. Cannot be deleted. It is the only predefined role that carries Data Lifecycle (legal holds and data lifecycle purge) and Promotion permissions; these must be granted to other roles explicitly. | All actions in all categories |
| API Developer | Role that can manage API Proxies, deploy, and perform integration operations. | API Management (including Deploy/Undeploy), API Creator, API Integrator, Global Settings, Connections, Identity & Access Control, Secrets & Certificates, Monitoring, Analytics & Reports, Project Management |
| API Manager | Role that can manage APIs, perform analysis and monitoring. | API Management (including Deploy/Undeploy), Monitoring, Analytics & Reports, Project Management |
| API Creator | Role that can perform API creation operations such as DB to API, Script to API, Mock API. | API Creator, Project Management |
| API Security | Role that manages identity management, consumers, certificates, and connection security. | Identity & Access Control, Secrets & Certificates, Connections, Project Management |
| API Analytics | Role that can perform analysis and reporting operations. | Analytics & Reports, Project Management |
| API Tester | Role that can perform test operations. | Testing, Project Management |
| AI Admin | Role with full control over AI development, AI budgets and AI analytics. | AI Development (including Deploy/Undeploy), AI Budgets |
| AI Developer | Role that manages, moves and deploys AI assets. | AI Development (including Deploy/Undeploy) |
| AI Analytics | Role with read-only observation of AI development, AI budgets and AI analytics. | — (View only) |
| AI Finance | Role that only views AI budgets/cost and AI analytics. | — (View only) |
System roles cannot be deleted.
When a new project is opened, the user who creates it and all users with the Project Admin authority are automatically added to the project with the Project Owner role.
If it is desired for a user or team to have more or less than the permissions in the default roles, a new role can be created that can be completely customized accordingly.
Creating a New Role
An image containing role creation settings is shown below:
The fields used for role creation configuration are shown in the table below.
| Field | Description |
|---|---|
| Name | Role name information for the created role. |
| Description | A description can be written to facilitate management related to the created role. |
| Authorities | Field where the permissions that the created role will have are selected. Permissions are added by selecting the checkbox for the relevant category and action. Permissions can be selected in bulk with the Select All / Clear All buttons and the Load Template menu (API Developer, API Manager, API Creator, API Security Manager, API Analytics Analyst, API Tester, API Viewer). |
Deleted roles are also deleted from projects and teams by the system.