Client IDとシークレットを取得する

このトピックでは、Client IDとクライアントシークレットを取得する方法について説明します。一部のセットアップタスクまたは統合タスクでは、のいずれかまたは両方が必要になります。

始める前に

管理者権限をお持ちで、Swaggerの基本事項を理解していることを確認してください。

管理者のみがクライアントシークレットをリクエストすることができます。さらに、クライアントシークレットはAPIリクエスト経由でのみ取得できます。

Client IDとシークレットをリクエストする

クライアントシークレットを取得するには、以下の手順に従ってください。

1. Swaggerを開きます：https://<your Tosca Cloud URL>/_identity/apiDocs/swagger

2. 「認証」を選択し、画面の指示に従います。「スコープ」については、必ずすべてを選択してください。認証トークンが作成されたら、ウィンドウを閉じます。

3. Client IDとアプリケーションIDを取得してください。

   • GET /_identity/api/v1/applicationsを選択します。

   • 「試す」、「実行」の順に選択します。

   • 応答の本文で、ユースケースに合うアプリケーションまでスクロールします。各アプリケーションには、それぞれclientIdがあります。また、そこにはアプリケーションのidも含まれています。これは次のステップでクライアントシークレットを取得するために必要となります。

     以下の表には、ユースケースとそのアプリケーションが列挙されています。

     ユースケース	アプリケーション
     Set up a シミュレータAgent	Simulator Agents
     Tosca on-premとのテスト実行統合機能を設定する（新しいタブで開きます）	Tosca Server
     Integrate Tosca Cloud in a CI/CD pipeline	Tricentis_Cloud_API

4. クライアントシークレットを取得してください。

   • GET /_identity/api/v1/applications/{Id}/secretsを選択します。

   • 「試す」を選択します。

   • 「Id」テキストフィールドにアプリケーションIDを入力します。次に、「実行」を選択します。

   • 結果として得たサーバーの応答からclientSecretをコピーします。

Clientシークレットを管理する

Swaggerのページには、クライアントシークレットを管理するためのコマンドも用意されています。

• 新しいクライアントシークレットを生成するには、POST /_identity/api/v1/applications/{id}/secretsを使用します。
• クライアントシークレットを削除するには、DELETE /_identity/api/v1/applications/{id}/secrets/{secretId}を使用します。