API キーの更新
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
PATCH /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
ORG-ID | string | |
API-KEY-ID | string |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 説明 | default | ||||
|---|---|---|---|---|---|---|---|
pageNum | integer | ページ番号（1 インデックス ベース）。 | 1 | ||||
itemsPerPage | integer | 1 ページあたりに返す項目の数は最大 500 です。 | 100 | ||||
pretty | ブール値 | レスポンス本体を pretty-print に含めるかどうかを示します 形式。 | false | ||||
envelope | ブール値 | 応答をエンベロープでラップするかどうかを示します。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
結果のリストを返すエンドポイントの場合、 | なし |
リクエスト ボディ パラメータ
名前 | タイプ | 必須/オプション | 説明 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
desc | string | 任意 | キーの説明。 このパラメーターは任意です。ただし、リクエストには descパラメータまたはrolesパラメータのいずれかが含まれている必要があります。 descを指定する場合、長さは 1 文字から 250 文字の間である必要があります。 | ||||||||||
roles | string 配列 | 任意 | APIキーが持つ必要があるロールのリスト。 このパラメーターは任意です。ただし、リクエストには 組織ロールには、以下が含まれます。
|
応答
名前 | タイプ | 説明 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | API キーの一意の識別子 | ||||||||||
desc | string | API キーの説明 | ||||||||||
privateKey | string | API キーの編集済み秘密キー | ||||||||||
publicKey | string | API キーの公開キー | ||||||||||
roles | オブジェクト配列 | API キーが持つロール | ||||||||||
roles.{ENTITY-ID} | string | {ENTITY-ID}は、このロールが適用される組織またはプロジェクトを表します。 可能な値はorgIdまたはgroupIdです。 | ||||||||||
roles.roleName | string | ロールの名前。
|
リクエストの例
注意
リクエストを行うユーザーは、 {USERNAME}:{APIKEY}または{PUBLIC-KEY}:{PRIVATE-KEY}として指定できます。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}?pretty=true" \ --data '{ "desc" : "Updated |api| key description for test purposes", "roles": ["ORG_MEMBER", "ORG_READ_ONLY"] }'
応答例
応答ヘッダー
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
レスポンス本体
{ "desc" : "Updated |api| key description for test purposes", "id" : "5c47ba5127d9d61b9fd8a27b", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b", "rel" : "self" } ], "privateKey" : "********-****-****-db2c132ca78d", "publicKey" : "kzurbulc", "roles" : [ { "orgId" : "5980cfc70b6d97029d82e3f6", "roleName" : "ORG_MEMBER" }, { "orgId" : "5980cfc70b6d97029d82e3f6", "roleName" : "ORG_READ_ONLY" } ] }