合成クレデンシャル Vault API

合成クレデンシャル Vault API を使用すると、管理者はログイン情報を安全に管理できます。このドキュメントでは、 API を使用してログイン情報を作成、一覧表示、更新、およびアップロードする方法について詳しく説明します。

前提条件

次の点を確認します。

  • API クライアントを作成できる管理者ロールがある。
  • APIクライアントには、LIST、CREATE、UPDATE、および UPLOAD アクションを実行するためのクレデンシャル Vault の管理権限がある。
  • API クライアントには、ログイン情報の値を表示するための セルフクレデンシャルの管理権限がある。

ロールの関連付け

ロールを API クライアントに関連付けるには、次の手順を実行します。

  1. [Settings > Administration > Roles] に移動します。
  2. カスタム ロールを作成します。
  3. ロールをクレデンシャル Vault の管理権限またはセルフクレデンシャルの管理権限のいずれかに関連付けます。
  4. API クライアントにロールを割り当てます。

[ベース URL（Base URL）] 

https://<controller-url>/controller/restui/eumSyntheticCredentialsUiService/

クレデンシャル Vault の作成

指定された JSON ペイロードから新しいクレデンシャル Vault を作成します。

リソースURL

POST <controller- url>/controller/restui/eumSyntheticCredentialsUiService/create

要求/応答の形式

JSON

例

この例では、クレデンシャル Vault に 1 つのキーと値のペアを作成します。

リクエスト
{
"credentials": [
{
"credentialName": "URL",
"credentialValue": "https//www.appdynamics.com/"
}
]
}
レスポンス
Status code 204. No response body returned.

すべてのログイン情報のキーと値のペアの取得

このAPI は、使用可能なすべてのログイン情報のキーと値のペアを表示します。

リソースURL

POST <controller- url>/controller/restui/eumSyntheticCredentialsUiService/data

応答形式

JSON

応答の例

{
"sortDirection": "ASC",
"sortColumnName": "KEY",
"searchString": "",
"pageOffsetKey": null
}

特定のアプリケーションのログイン情報のキーと値のペアの取得

このAPI は、指定されたアプリケーションのすべてのログイン情報のキーと値のペアを表示します。

リソースURL

GET <controller- url>/controller/restui/eumSyntheticCredentialsUiService/list/<application-id>

応答形式

JSON

応答の例

{
"credentialNamesInApp": [
"url"
],
"credentialNamesNotInApp": [
"appdymics_secret",
"github_pass"
]
}

ログイン情報のキーと値のペアの更新

このAPI は、クレデンシャル Vault 内のキーと値のペアを更新します。バージョンは必須であり、更新リクエストごとに増分する必要があります。

リソースURL

PUT <controller- url>/controller/restui/eumSyntheticCredentialsUiService/update

応答形式

JSON

例

リクエスト
{
"credentials": [
{
"credentialName": "URL",
"credentialValue": "www.appdynamics.com",
"appId": 24,
"version": 4
}
]
}
レスポンス
Status code 204. No response body returned.

ログイン情報のキーと値のペアのアップロード

この API は、複数のキーと値のペアをクレデンシャル Vault にアップロードします。

リソースURL

POST <controller- url>/controller/restui/eumSyntheticCredentialsUiService/upload

応答形式

JSON

例

リクエスト
{
"credentials": [
{
"credentialName": "URL",
"credentialValue": "www.appdynamics.com"
},
{
"credentialName": "username",
"credentialValue": "appd_user"
}
]
}
レスポンス
Status code 204. No response body returned.