認証情報を更新する

PUT リクエストを送信して、認証情報名または説明、属性名または説明、入力タイプ、値マスキング、またはパスワード フラッグを更新します。

前提条件

JSON Web トークン (JWT)
すべての Control Room API には API にアクセスするための JSON Web トークン (JWT) が必要です。認証 API を使用して認証トークンを生成します。
権限
認証情報プロパティを更新するには、認証情報の所有者である必要があります。
注:
  • API をテストするには、Control Room にインストールされた Swagger 定義ファイルを使用します。利用可能な Swagger API は http://<your_control_room_url>/swagger/ で参照できます。
  • また、REST Client を使用してこのタスクを完了することもできます。

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
    注: 認証 API を使用して JSON Web トークンを生成します。
  2. メソッドと URL を指定します。
    • メソッド: PUT
    • URL: http://<your_control_room_url>/v2/credentialvault/credentials/{id}
  3. 更新するフィールドと値を追加します。
    リクエスト本文:
    {
"name": "Email connection parameters",
  "description": "",
  "ownerId": "14",
  "attributes": [
    {
      "id": "61",
      "name": "outlook password",
      "description": "",
      "userProvided": true,
      "masked": false,
      "createdBy": "14",
      "createdOn": "2020-01-27T19:07:12.363Z",
      "updatedBy": "14",
      "updatedOn": "2020-01-27T19:07:12.363Z",
      "version": "2",
      "passwordFlag": true
    }
  ],
  "createdBy": "14",
  "createdOn": "2019-12-19T21:35:45.326Z",
  "updatedBy": "14",
  "updatedOn": "2020-01-27T19:07:12.364Z",
  "version": "4"
}
  4. リクエストを送信します。
    • REST Client で [SEND] をクリックします。
    • Swagger インターフェースで [実行] をクリックします。
    この例のレスポンスは、新しい認証情報に関する情報を返します。この例では、更新されたフィールドを確認します。更新日時およびバージョンも含まれます。認証情報が更新されるたびに、バージョン値は 1 ずつ増えます。

    レスポンス本文:

    {
  "id": "12",
  "name": "Email connection parameters",
  "description": "",
  "ownerId": "14",
  "attributes": [
    {
      "id": "61",
      "name": "outlook password",
      "description": "",
      "userProvided": true,
      "masked": false,
      "createdBy": "14",
      "createdOn": "2020-01-27T19:09:19.560Z",
      "updatedBy": "14",
      "updatedOn": "2020-01-27T19:09:19.560Z",
      "version": "3",
      "passwordFlag": true
    }
  ],
  "createdBy": "14",
  "createdOn": "2019-12-19T21:35:45.326Z",
  "updatedBy": "14",
  "updatedOn": "2020-01-27T19:09:19.560Z",
  "version": "5"
}
また、コマンド ターミナルから REST リクエストを実行することもできます。これは、リクエストの Curl 例です。この例は、読みやすいようにフォーマットされています。かぎ括弧内のテキストを適切な値に置き換えます。
curl -X POST "<your_control_room_url>/v2/credentialvault/credentials"
                -H "accept: application/json" -H "X-Authorization: <authentication_token>"
                -H "Content-Type: application/json" -d "{ \"id\": \"<credential_id>\",
                \"name\": \"<credential_name>\", \"description\": \"<credential_description>\",
                \"ownerId\": \"<owner_id>\", \"attributes\": [], \"createdBy\": \"<user_id>\",
                \"createdOn\": \"<date_time>\", \"updatedBy\": \"<user_id>\",
                \"updatedOn\": \"<date_time>\", \"version\": \"<version_number>\"}"