Skip to content

Project Onboarding

Overview

Project onboarding is a crucial process to ensure proper setup and management of projects within a tenant. This involves creating, updating, and managing projects, as well as associating KeyConnector. The following sections provide detailed steps and permissions for various project-related actions.

Project Management

1. Creating a Project

  • Action: Create a new project.
  • Performed by: Tenant Admin.
  • Details: A tenant admin can initiate the creation of a new project. During this process, the KeyConnector can be associated with the project to ensure secure request execution and secret management.

2. Updating a Project

  • Action: Update an existing project.
  • Performed by: Tenant Admin, Project Admin.
  • Details: Both tenant admins and project admins have the ability to update project details. This includes modifying project settings and associating or reconfiguring the KeyConnector.

3. Deleting a Project

  • Action: Soft delete a project.
  • Performed by: Tenant Admin, Project Admin.
  • Details: Projects can be soft deleted by tenant admins or project admins. Soft deleting a project ensures that the data is not permanently removed immediately, allowing for potential recovery if needed.

4. Associating KeyConnector

  • Action: Associate KeyConnector to a project.
  • Performed by: During project creation and updating.
  • Details: KeyConnector should be associated with the project during both the creation and updating processes to enable secure execution of API requests and secret management.

5. Retrieving All Projects of a Tenant

  • Action: Get all projects of a tenant.
  • Performed by: Tenant Admin.
  • Details: Tenant admins can retrieve a list of all projects under their tenant to manage and oversee project activities effectively.

6. Retrieving Projects Based on User Role/Permission

  • Action: Get projects from a tenant based on user role/permission.
  • Performed by: Authorized Users.
  • Details: Users can retrieve projects based on their specific roles and permissions, ensuring they have access to the projects they are involved in.

7. Adding Users to a Project

  • Action: Add users to a project.
  • Performed by: Tenant Admin, Project Admin.
  • Details: Both tenant admins and project admins can add users to a project, assigning appropriate roles and permissions as necessary.

8. Removing Users from a Project

  • Action: Soft delete users from a project.
  • Performed by: Tenant Admin, Project Admin.
  • Details: Users can be soft deleted from a project by tenant admins and project admins, ensuring their access is revoked while maintaining data integrity for audit purposes.

9. Retrieving All Users of a Project

  • Action: Get all users of a project.
  • Performed by: Tenant Admin, Project Admin.
  • Details: Tenant admins and project admins can retrieve a list of all users associated with a project, including their roles and permissions.

This documentation provides a comprehensive guide to project onboarding within a tenant. For detailed instructions and advanced configurations, refer to the relevant sections in the API documentation or contact your system administrator.

Released under the MIT License.