Understanding the Tenant Management API

You can perform system management tasks using the Tenant Management REST API instead of the Tenant Manager user interface. For example, you might want to use the API to automate operations or to create multiple entities, such as users, more quickly.

The Tenant Management API uses the Swagger open source API platform. Swagger provides an intuitive user interface that allows developers and non-developers to interact with the API. The Swagger user interface provides complete details and documentation for each API operation.

To access the Swagger documentation for the Tenant Management API:

  1. Sign in to the Tenant Manager.
  2. Select Help > API Docs from the web application header.


    screenshot showing how to access the API Docs menu item

API operations

The Tenant Management API organizes the available API operations into the following sections:

Operation details

When you expand each API operation, you can see its HTTP action, endpoint URL, a list of any required or optional parameters, an example of the request body (when required), and the possible responses.


example showing GET groups operation in Swagger API

Issuing API requests

Attention: Any API operations you perform using the Swagger user interface are live operations. Be careful not to create, update, or delete configuration or other data by mistake.
Steps
  1. Click the HTTP action to see the request details.
  2. Determine if the request requires additional parameters, such as a group or user ID. Then, obtain these values. You might need to issue a different API request first to get the information you need.
  3. Determine if you need to modify the example request body. If so, you can click Model to learn the requirements for each field.
  4. Click Try it out.
  5. Provide any required parameters, or modify the request body as required.
  6. Click Execute.
  7. Review the response code to determine if the request was successful.