As mentioned in :ref:`provisioning`, the NVIDIA FLARE system requires a set of startup kits which include the private keys and certificates (signed by the root CA) in order to communicate to one another. The new :ref:`nvflare_dashboard_ui` in NVIDIA FLARE provides a simple way to collect information of clients and users from different organizations, as well as to generate those startup kits for users to download.
Most of the details about provisioning can be found in :ref:`provisioning`. In this section, we focus on the user interaction with Dashboard and its backend API.
The Dashboard backend API follows the Restful concept. It defines four resources, Project, Organizations, Client and User. There is one and only one Project. The Project includes information about server(s) and overseer (if in HA mode). Clients are defined for NVIDIA FLARE clients and Users for NVIDIA FLARE admin console. Organizations is a GET only operation, which returns a list of current registered organizations.
The following is the complete definition of the backend API, written in OpenAPI 3.0 syntax. Developers can implement the same API in different programming language or develop different UI while calling the same API for branding purpose.
.. literalinclude:: ../../nvflare/dashboard/dashboard.yaml :language: yaml
Most of the backend API requires users to login to obtain JWT for authorization purpose. The JWT includes claims of user's organization and his/her role. The JWT itself always has the user's email address (user id for login).
As shown in the above section, only GET /project, GET /users and GET /organizations can be called without login credential.
The project_admin role can operate on any resources.
Because the project itself contains information requires by clients and users, changing project information after clients and users are created will cause incorrect dependencies. It is required for the project_admin to freeze the project after all project related information is set and finalized so that the Dashboard web can allow users to signup. Once the project is frozen, there is no way, from the Dashboard web, to unfreeze the project.
The following is the schema of the underlying database used by the backend API.
