新しい資格情報の作成

POST リクエストを送信して新しい資格情報を作成します。

前提条件

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 を指定します。
    • メソッド: POST
    • URL: http://<your_control_room_url>/v2/credentialvault/credentials
  3. 値を追加して資格情報を設定します。
    リクエストの例には、以下のオプションが含まれています。
    • [資格情報名]は E メールです。
    • 資格情報の説明 (オプション) は、E メール ログインとパスワードに使用します。
    • 属性名は Password です。
    • はユーザーが提供します。

      この資格情報がロッカーに保存されると、ロッカーのコンシューマーは属性値を提供する E メール通知を受信します。

    • はマスクされています。呼び出されると、値は空の文字列として返されます。
    • はパスワードとしてフラグ付けされます。

      このオプションが選択された属性は、パスワード タイプのフィールドでのみ使用できます。属性は公開されず、その値はメモ帳などのプレーン テキスト アプリケーションには出力できません。詳細については、「資格情報変数をサポートするコマンド」をご覧ください。

    リクエスト本文:
    {
      "name": "Email",
      "description": "Used for email login and password",
      "attributes": [
        {
          "name": "Password",
          "userProvided": true,
          "masked": true,
          "passwordFlag": true
        }
      ]
    }
  4. リクエストを送信します。
    • REST Client で [SEND] をクリックします。
    • Swagger インターフェースで [実行] をクリックします。
    この例のレスポンスは、新しい認証情報に関する情報を返します。レスポンスの例には、以下の情報が含まれています。
    • 資格情報 ID は 17 です。
    • 所有者 ID は 14 です。
    • 属性 ID は 70 です。

    レスポンス本文:

    {
    "id": "17",
    "name": "Email",
    "description": "Used for email login and password",
    "ownerId": "14",
    "attributes":[
        {
            "id": "70",
            "name": "Password",
            "description": "",
            "userProvided": true,
            "masked": true,
            "createdBy": "14",
            "createdOn": "2019-12-23T19:01:13.449Z",
            "updatedBy": "14",
            "updatedOn": "2019-12-23T19:01:13.449Z",
            "version": "0",
            "passwordFlag": true
        }
    ],
    "createdBy": "14",
    "createdOn": "2019-12-23T17:42:43.802Z",
    "updatedBy": "14",
    "updatedOn": "2019-12-23T17:42:43.802Z",
    "version": "0"
    }
注: また、コマンド ターミナルから REST リクエストを実行することもできます。これは、Curl リクエストの例です。この例は、読みやすいようにフォーマットされています。角括弧内のテキスト <authentication_token> を認証トークンに置き換えます。
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 "{
             \"name\": \"Email\",
             \"description\": \"Used for email login and password\",
             \"attributes\":
              [
                { \"name\": \"Password\",
                  \"userProvided\": true,
                  \"masked\": true,
                  \"passwordFlag\": true } 
               ]
            }"