1 つのクラウドプロバイダーのアクセスロールの承認を解除

DELETE /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}

サービスアカウント DigestAuth

指定されたアクセスロールの指定されたプロジェクトへのアクセスを取り消します。このリソースを使用するには、リクエスト元のサービスアカウントまたは API キーにプロジェクトオーナーロールが必要です。

path パラメータ

グループ ID string 必須

プロジェクトを識別する一意の 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
cloudProvider string 必須

認証解除するロールのクラウドプロバイダーを識別する、人間が判読できるラベル。

値は AWS、AZURE、または GCP です。
roleId string 必須

ロールを識別するユニークな 24 桁の 16 進数の文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

クエリパラメータ

envelope ブール値

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータスパラメータを追加します。

デフォルト値はfalseです。
pretty ブール値

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

デフォルト値はfalseです。

Prettyprint

応答

204 application/vnd.atlas.2023-01-01+json

コンテンツはありません
400 application/ JSON

無効なリクエストです。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。
401 application/ JSON

許可されていません。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。
403 application/ JSON

Forbidden.
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。
404 application/ JSON

見つかりません。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。
500 application/ JSON

内部サーバーエラー。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。

DELETE /API/Atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}

atlas api deauthorizeCloudProviderAccessRole --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250219001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.DeauthorizeCloudProviderAccessRoleApiParams{}
	httpResp, err := client.CloudProviderAccessApi.
		DeauthorizeCloudProviderAccessRoleWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}"

応答の例（400）

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

応答の例（401）

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

応答の例（403）

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

応答の例（404）

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

応答の例（500）

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

1 つのクラウドプロバイダーのアクセス ロールの承認を解除

path パラメータ

クエリ パラメータ

応答

1 つのクラウドプロバイダーのアクセスロールの承認を解除

クエリパラメータ