1 つのプロジェクトで 1 つの組織 API キーの割り当てを解除

項目一覧

Resource

リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
リクエストの例
応答例
応答ヘッダー
レスポンス本体

Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。

Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。: 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用するサービスアカウントを作成します。

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

Resource

DELETE /orgs/{PROJECT-ID}/apiKeys/{API-KEY-ID}

リクエストパスパラメーター

名前	タイプ	説明
`PROJECT-ID`	string	APIキーから割り当てを解除するプロジェクトの一意の識別子。認証済みユーザーがアクセスできるすべての組織を取得するには、 /groupsエンドポイントを使用します。
`API-KEY-ID`	string	更新するAPIキーの一意の識別子。 /groups/{PROJECT-ID}/apiKeysエンドポイントをリクエストして、指定された組織の認証済みユーザーがアクセスできるすべてのAPIキーを取得します。

リクエストクエリパラメータ

次のクエリパラメータは任意です。

名前

タイプ

説明

default

pageNum

integer

ページ番号（1 インデックスベース）。

1

itemsPerPage

integer

1 ページあたりに返す項目の数は最大 500 です。

100

pretty

ブール値

レスポンス本体を pretty-print にするかどうかを示します形式。

false

envelope

ブール値

応答をエンベロープでラップするかどうかを示します。

一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで"envelope" : trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

結果のリストを返すエンドポイントの場合、 resultsオブジェクトはエンベロープです。 Cloud Manager は、レスポンス本体にstatusフィールドを追加します。

なし

リクエストボディパラメータ

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

リクエストの例

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request DELETE "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys/5d1d12c087d9d63e6d682438"

応答例

応答ヘッダー

HTTP/1.1 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

HTTP/1.1 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 つのプロジェクトに対する 1 つの組織 API キーのロールを変更

サービスアカウント

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request DELETE "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys/5d1d12c087d9d63e6d682438"