Get client ID and secret

This topic explains how to get client ID and client secret. You'll need one or both for some setup or integration tasks.

Before you start

Make sure you have administrator rights and a basic understanding of Swagger.

Only administrators can request a client secret. Plus, client secrets are only available via API request.

Request client ID and secret

To get the client secret, follow these steps:

1. Open Swagger: https://<your Tosca Cloud URL>/_identity/apiDocs/swagger

2. Select Authorize and follow the instructions on the screen. For Scopes, make sure to select all. Once the authorization token has been created, close the window.

3. Retrieve the client ID and the application ID:

   • Select GET /_identity/api/v1/applications.

   • Select Try it out, then Execute.

   • In the response body, scroll to the application that fits your use case. Each application has the respective clientId. It also has the application's id, which you'll need in the next step, to get the client secret.

     The following table lists use cases and their applications:

     Use case	Application
     Set up a Simulator agent	Simulator Agents
     Set up the test execution integration with Tosca on-prem (opens in new tab)	Tosca Server

4. Retrieve the client secret:

   • Select GET /_identity/api/v1/applications/{Id}/secrets.

   • Select Try it out.

   • In the Id text field, enter the application ID. Then, select Execute.

   • From the resulting server response, copy the clientSecret.

Manage client secrets

The Swagger page also offers commands to manage your client secret:

• To generate a new client secret, use POST /_identity/api/v1/applications/{id}/secrets.
• To delete a client secret, use DELETE /_identity/api/v1/applications/{id}/secrets/{secretId}.