指定した Cloud Manager 組織への保留中の招待を 1 件削除します。 ユーザーが承諾した招待を削除することはできません。
必須のロール
Organization User Adminロールを使用して、このエンドポイントを正常に呼び出すことができます。
Resource
ベース URL: https://cloud.mongodb.com/api/public/v1.0
DELETE /orgs/{ORG-ID}/invites/{INVITATION-ID}リクエスト パス パラメーター
path 要素 | タイプ | 必要性 | 説明 |
|---|---|---|---|
ORG-ID | string | 必須 | 組織を識別する一意な 24 桁の 16 進数のstring 。 |
招待ID | string | 必須 | 招待を識別するユニークな 24 桁の 16 進数の文字列。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
このエンドポイントには、応答要素がありません。
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \ --header "Accept: application/json" \ --request DELETE "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invitations/{INVITATION-ID}"応答例
応答ヘッダー
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 204 No ContentVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}レスポンス本体
このエンドポイントは空のJSONオブジェクトを返します。