Tenant Management API

The DSH contains a REST API to manage several aspects of your tenant:

• Resources:
  • Buckets
  • Certificates
  • Kafka topics of type “scratch”
  • Secrets
  • Volumes
• Services:
  • Database as a Service
  • Flink cluster
  • Kafka Proxy
• Your own services, and applications from the App Catalog.
• You can create other tenants (so-called managed tenants), and manage them via the Tenant Management API:
  • Managed tenants
  • Managed tenant limits
  • Managed streams

Accessing the Tenant Management API

The DSH Console contains more information about accessing the Tenant Management API. Click “Services” > “REST API” in the menu bar of the DSH Console to find out more about the API:

• The “Open the API Specification” button leads to the Swagger UI of the Tenant Management API, in a new tab.
• Under “Your API Credentials”, you find the information to access the Tenant Management API:
  • Client ID: The ID that you need to use in the OAuth authentication flow.
  • Client Secret:
    • Click the “View” button to inspect the secret.
    • Click the “Generate new Client Secret” button to delete the secret and create a new one. The old secret will no longer work, wich may break the connection of existing clients.
• Under “Getting Started”, you find an HTTP call to connect to the Tenant Manegement API.

Warning

Be careful if you generate a new client secret. Doing so will revoke the existing client secret, which may break connections to the API for existing clients.