Given the information from the introductory tutorial, you are now ready to learn to call the SPP API using the built-in Swagger UI. Swagger is based on the OpenAPI specification which provides a way to document an entire API like the SPP API in a single file. SPP code that serves the SPP API generates an OpenAPI file during build. This OpenAPI file may be downloaded from any of the SPP API services: core, appliance, notification, event, and a2a.
| Service | Description |
|---|---|
| core | Most product functionality is found here. All cluster-wide operations: access request workflow, asset management, policy management, etc. |
| appliance | Appliance-specific operations, such as setting IP address, maintenance, backups, support bundles, appliance management |
| notification | Anonymous, unauthenticated operations. This service is available even when the appliance isn't fully online |
| event | Specialized endpoint for connecting to SignalR for real-time events |
| a2a | Application integration specific operations. Fetching passwords, making access requests on behalf of users, etc. |
Each service has its own OpenAPI file. However, the OpenAPI file for the event service is not really useful as that endpoint just provides for SignalR connectivity.
Swagger UI is generated along with the Swagger OpenAPI file to visualize and interact with the SPP API in place without having to implement a client.
START HERE: Hands-on Lab
In this lab you will perform the following:
- Find the Swagger OpenAPI file.
- Find Swagger UI.
- Call the notification service -- anonymous GET.
- Authenticate to Safeguard using Swagger UI.
- Call the core service to create a user.
- Call the core service to set the user password.
- Use query parameters.
- Perform maintenance operations available on the appliance service.