そのキーの一意の識別子を使用して、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
リクエスト パス パラメーター
すべてのリクエスト パス パラメータが必要です。
名前 | タイプ | 説明 |
|---|---|---|
| string | 更新対象のグローバルAPIキーの一意の識別子。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
2 つの本体パラメータのうち 1 つまたは両方を指定する必要があります。
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
| string | 条件付き | キーの説明。 このパラメーターは任意です。ただし、リクエストには |
| string 配列 | 条件付き | グローバル API キーが持つ必要があるロールのリスト。もし
デフォルトで受け入れられるグローバル ロールは次の通りです。
|
応答
名前 | タイプ | 説明 |
|---|---|---|
| string | このグローバルAPIキーの説明。 |
| string | このグローバルAPIキーの一意の識別子。 |
| string | ドキュメントの配列は、1 つまたは複数のサブリソースまたは関連リソース ( リストのページネーション など) への リンク を表現します。詳細については、連携を参照してください。 |
| string | このグローバルAPIキーの編集済み秘密キー。 |
| string | このグローバルAPIキーの公開キー。 |
| オブジェクト配列 | このグローバルAPIキーが持つロール。 この配列は、MongoDB Ops Manager でユーザーが持っているすべてのグローバル ロールを返します。 |
| string | ロールの名前。 このリソースは、MongoDB Ops Manager でユーザーが持っているすべてのロールを返します。 可能な値は次のとおりです。
|
リクエストの例
注意
リクエストを行うユーザーは、 {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/admin/apiKeys/{API-KEY-ID}?pretty=true" \ --data '{ "desc" : "Updated API key description for test purposes" }'応答例
応答ヘッダー
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}レスポンス本体
{ "created": "2019-09-04T15:37:40Z", "desc": "Updated API key description for test purposes", "globalRoles": ["GLOBAL_READ_ONLY"], "groupRoles": [], "numGroups": 0, "orgRoles": [], "orgRolesString": "", "privateKey": "********-****-****-cfe60e9f1f72", "userId": "5d6fda44ff4ab7133648a852", "username": "dczverfw"}