Get a client secret

You need a client secret in the following cases:

• To set up a team agent via CLI.

• To set up your Simulator agent via appsettings.yml file.

• To set up the integration (opens in new tab) with Tricentis Tosca on-prem, which allows you to run your on-prem tests in the cloud.

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 the secret

To get the client secret, follow these steps:

1. Open Swagger: https://<your Tricentis Tosca in the 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 application ID:

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

   • Select Try it out, then Execute.

   • In the response body, scroll down to the respective application and copy its ID for the next step:

     • If you want to set up a team agent, copy the ID of the application Elastic Execution Grid Agents.
     • If you want to set up a Simulator agent, copy the ID of the application Simulator Agents.
     • If you want to set up the integration with Tricentis Tosca on-prem, copy the ID of the application 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.

5. 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}.