API を使用して属性値を持つ資格情報を構成する

Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

PDF をダウンロード

API を使用して属性値を持つ資格情報を構成する

標準属性を持つ資格情報を作成し、ユーザー入力値を持つ 2 つの属性を追加します。

前提条件

注: Community Edition で Control Room APIs を表示できますが、API 機能は制限されています。API のすべての機能にアクセスするには、Automation 360 のライセンス版が必要です。

すべての API 呼び出しは、リクエストヘッダーに認証トークンを含める必要があります。認証 API を使用して JSON Web トークンを生成します。「認証 API」を参照してください。
すべてのロールには、資格情報と属性を構成するために必要な [Manage my credentials and lockers] 権限があります。このエンドポイントの使用には、追加の権限は必要ありません。

この例では、E メールのホスト名、ユーザー名、およびパスワードを保持する 3 つの属性を持つ資格情報を構成します。

手順

リクエストヘッダーに認証トークンを追加します。

資格情報を作成する:

POST メソッドとエンドポイント URL を使用します。 <your_control_room_url>/v2/credentialvault/credentials。
リクエスト本文: このリクエストの例には、次の必須パラメーターが含まれています。
- userProvided:属性がユーザーの入力を必要とするか (true)、すべてのユーザーに対して標準であるか (false) を設定するブール値。
- masked:属性値をアスタリスクでマスクするか (true)、ユーザーに表示するか (false) を設定するブール値。
```
{
  "name": "Email",
  "attributes": [
  	{
      "name": "hostname",
      "userProvided": false,
      "masked": false
    } 	
  ]
}
```

リクエストを送信します。

レスポンス本文: 正常にリクエストされた場合、このエンドポイントは次のデータを返します。

id:資格情報の一意の数値識別子。
attributes:id:属性の一意の数値識別子。

{
    "id": "1630",
    "name": "Email",
    "description": "",
    "ownerId": "1508",
    "attributes": [
        {
            "id": "3335",
            "name": "hostname",
            "description": "",
            "userProvided": false,
            "masked": false,
            "createdBy": "1508",
            "createdOn": "2020-12-28T22:04:41.366448Z",
            "updatedBy": "1508",
            "updatedOn": "2020-12-28T22:04:41.366450Z",
            "version": "0",
            "passwordFlag": false
        }
    ],
    "createdBy": "1508",
    "createdOn": "2020-12-28T22:04:41.366460Z",
    "updatedBy": "1508",
    "updatedOn": "2020-12-28T22:04:41.366464Z",
    "version": "0"
}

REST API は、HTTP レスポンスコードで各リクエストに応答します。レスポンスコードについては、「API レスポンスコード」を参照してください。

資格情報へのホスト名属性に標準値を割り当てます。

POST メソッドとエンドポイント URL を使用します。<your_control_room_url>/v2/credentialvault/credentials/{credentialId}/attributevalues
```
{
  "list": [
    {
      "credentialAttributeId": "3335",
      "value": "mail.example.com"
    }
  ]
}
```

リクエストを送信します。

レスポンス本文:

{
  "list": [
    {
      "id": "1630",
      "credentialAttributeId": "3335",
      "value": "mail.example.com",
      "userId": "1508",
      "createdBy": "1508",
      "createdOn": "2020-12-28T22:04:41.366460Z",
      "updatedBy": "1508",
      "updatedOn": "2020-12-28T22:04:41.366464Z",
      "version": "0"
    }
  ]
}

username 属性と password 属性を Email 資格情報に追加します。PUT メソッドとエンドポイント URL を使用します。<your_control_room_url>/v2/credentialvault/credentials/{credentialId}。
注: 新しい属性とともに既存の属性をリクエストに含める必要があります。そうしないと、現在の属性が上書きされます。
リクエスト本文: リクエスト URL で資格情報 ID を指定しているため、リクエスト本文に資格情報 ID または名前を含める必要はありません。この例では、リクエスト本文の username と password の属性は、各ユーザーから異なる入力を受け入れる値で構成されます。また、パスワード属性は、入力された値をアスタリスクでマスクするように構成されています。
```
{
    "attributes": [
  	{
      "name": "username",
      "userProvided": true,
      "masked": false
    },
     {
      "name": "password",
      "userProvided": true,
      "masked": true
    },
     {
      "name": "hostname",
      "userProvided": false,
      "masked": false
    } 		
  ]
}
```

リクエストを送信します。

レスポンス本文: レスポンス本文は、3 つの属性の詳細を含む資格情報を返します。

{
    "id": "1630",
    "name": "Email",
    "description": "",
    "ownerId": "1508",
    "attributes": [
        {
            "id": "3335",
            "name": "hostname",
            "description": "",
            "userProvided": false,
            "masked": false,
            "createdBy": "1508",
            "createdOn": "2020-12-28T22:04:41.366448Z",
            "updatedBy": "1508",
            "updatedOn": "2020-12-28T22:04:41.366450Z",
            "version": "0",
            "passwordFlag": false
        },
        {
            "id": "3336",
            "name": "username",
            "description": "",
            "userProvided": true,
            "masked": false,
            "createdBy": "1508",
            "createdOn": "2020-12-28T22:04:41.366450Z",
            "updatedBy": "1508",
            "updatedOn": "2020-12-28T22:04:41.366450Z",
            "version": "0",
            "passwordFlag": false
        },
        {
            "id": "3337",
            "name": "password",
            "description": "",
            "userProvided": true,
            "masked": true,
            "createdBy": "1508",
            "createdOn": "2020-12-28T22:04:41.366450Z",
            "updatedBy": "1508",
            "updatedOn": "2020-12-28T22:04:41.366450Z",
            "version": "0",
            "passwordFlag": false
        }
    ],
    "createdBy": "1508",
    "createdOn": "2020-12-28T22:04:41.366460Z",
    "updatedBy": "1508",
    "updatedOn": "2020-12-28T22:06:35.366464Z",
    "version": "2"
}

次のステップ

資格情報 Vault の設定手順を実行する場合は、次の操作を行います。資格情報をロッカー API に割り当てる。

フィードバックを送る