1 つのグローバル API キーを更新
項目一覧
そのキーの一意の識別子を使用して、MongoDB Ops Manager から 1 つのグローバル APIキーの値を更新します。
特定のグローバルAPIキーを見つけるには、 はグローバル API キーのリストを取得し、必要な {API-KEY-ID}を見つけます。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
PATCH /admin/apiKeys/{API-KEY-ID}
必須のロール
このエンドポイントを呼び出すAPIキーにGlobal Ownerロールが必要です。
Request Parameters
リクエスト パス パラメーター
すべてのリクエスト パス パラメータが必要です。
名前 | タイプ | 説明 |
|---|---|---|
API-KEY-ID | string | 更新対象のグローバルAPIキーの一意の識別子。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。 | false | ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
| false |
リクエスト ボディ パラメータ
2 つの本体パラメータのうち 1 つまたは両方を指定する必要があります。
名前 | タイプ | 必要性 | 説明 | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
desc | string | 条件付き | キーの説明。 このパラメーターは任意です。ただし、リクエストには descパラメータまたはrolesパラメータのいずれかが含まれている必要があります。 descを指定する場合、長さは 1 文字から 250 文字の間である必要があります。 | ||||||||||||||
roles | string 配列 | 条件付き | グローバルAPIキーが持つ必要があるロールのリスト。
デフォルトで受け入れられるグローバル ロールは次の通りです。
|
応答
名前 | タイプ | 説明 | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
desc | string | このグローバルAPIキーの説明。 | ||||||||||||||
id | string | このグローバルAPIキーの一意の識別子。 | ||||||||||||||
links | string | |||||||||||||||
privateKey | string | このグローバルAPIキーの編集済み秘密キー。 | ||||||||||||||
publicKey | string | このグローバルAPIキーの公開キー。 | ||||||||||||||
roles | オブジェクト配列 | このグローバルAPIキーが持つロール。 この配列は、MongoDB Ops Manager でユーザーが持っているすべてのグローバル ロールを返します。 | ||||||||||||||
roles.roleName | string | ロールの名前。 このリソースは、MongoDB Ops Manager でユーザーが持っているすべてのロールを返します。 可能な値は次のとおりです。
|
リクエストの例
注意
リクエストを行うユーザーは、 {USERNAME}:{APIKEY}または{PUBLIC-KEY}:{PRIVATE-KEY}として指定できます。
1 curl --user "{USERNAME}:{APIKEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?pretty=true" \ 5 --data '{ 6 "desc" : "Updated API key description for test purposes" 7 }'
応答例
応答ヘッダー
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}
レスポンス本体
1 { 2 "created": "2019-09-04T15:37:40Z", 3 "desc": "Updated API key description for test purposes", 4 "globalRoles": ["GLOBAL_READ_ONLY"], 5 "groupRoles": [], 6 "numGroups": 0, 7 "orgRoles": [], 8 "orgRolesString": "", 9 "privateKey": "********-****-****-cfe60e9f1f72", 10 "userId": "5d6fda44ff4ab7133648a852", 11 "username": "dczverfw" 12 }