Using Swagger UI

You can use Swagger UI to quickly try out the IBM® Security Guardium® Key Lifecycle Manager REST APIs.

About this task

Swagger is an open specification for defining REST APIs. Swagger UI is a display framework that can parse the OpenAPI specification and generate an interactive API console for users to quickly and easily learn and run the REST APIs. All the REST APIs are available on a single page.

Swagger UI is integrated with IBM Security Guardium Key Lifecycle Manager, and you can use it to try out and run any IBM Security Guardium Key Lifecycle Manager REST API.

You can use the credentials of any IBM Security Guardium Key Lifecycle Manager user to authenticate and make REST API requests in the Swagger UI.

Note: The Swagger UI is provided to you as-is. It contains the IBM Security Guardium Key Lifecycle Manager REST APIs. Any customization to the Swagger UI, for example, to display custom annotations or extra data, is not supported.
Here are the high-level steps to use Swagger UI:
  1. Access the Swagger UI.
  2. Authenticate and authorize the IBM Security Guardium Key Lifecycle Manager REST API operations.
  3. Run the REST APIs.

Procedure

  1. Access the Swagger UI.
    In any browser, enter the following URL: 
    https://host:9443/ibm/SKLM/swagger
    Where, host is the IP address of the host where the IBM Security Guardium Key Lifecycle Manager server is installed.
  2. Authenticate and authorize the REST API operations.
    1. Click Authorize.
    2. In the Authorization window, specify the login credentials, and click Login.
    3. Click Authorize and you can close the window.
      All the IBM Security Guardium Key Lifecycle Manager REST APIs are now authorized. You can now run and test any REST API.
  3. Run a REST API.
    1. Expand the method for the REST API that you want to run.
    2. Click Try it out.
    3. Specify the required parameters and click Execute.
    4. Review the response.