すべてのクラウドプロバイダーのアクセス ロールを返す

GET /api/atlas/v1.0/groups/{groupId}/cloudProviderAccess

指定されたプロジェクトへのアクセス権を持つすべてのクラウドプロバイダー アクセス ロールを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。

ロールの要件
  • プロジェクトオーナー

path パラメータ

  • グループ ID string 必須

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

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

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

クエリ パラメータ

  • envelope ブール値

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

    デフォルト値はfalseです。

  • pretty ブール値

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

    デフォルト値はfalseです。

    Prettyprint

応答

  • 200 application/ JSON

    OK

    応答属性の非表示 応答属性の表示 オブジェクト
    • awsIAMRoles array[オブジェクト]

      MongoDB Cloud に登録および認可されたAmazon Web Services (AWS )の IAM ロールを含むリスト。

      awsIAMRoles 属性を非表示にする awsIAMRoles 属性を表示する オブジェクト

      Amazon Web Services (AWS)の IAM(Identity and Access Management、ID とアクセス管理)ロールにリンクされた機能を説明する詳細。

      • providerName string 必須 弁別子

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

        値は CloudProviderAccessRole です。

      • _id string

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

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

      • atlasAzureAppId string(uuid)

        Atlas のAzure Active Directory アプリケーションID 。このフィールドは任意であり、指定しない場合はAzureサブスクリプションから取得されます。

      • createdDate string(date-time)

        指定されたクラウドサービス プロバイダーに対してこのロールを作成した日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

      • featureUsages array[オブジェクト]

        このAmazon Web Services (AWS )の IAM(Identity and Access Management、ID とアクセス管理)ロールに関連付けられているアプリケーション機能を格納したリスト。

        次の 1 つ:
      • lastUpdatedDate string(date-time)

        このAzure Service Principal が最後に更新された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

      • servicePrincipalId string(uuid)

        Azureサービス プリンシパルを識別する UUID 文字列。

      • tenantId string(uuid)

        Azure Active Directory テナントIDを識別する UUID 文字列。

      • gcpServiceAccountForAtlas string

        Atlas によって作成された Google サービス アカウントのメールアドレス。

        形式は次のパターンと一致する必要があります: ^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$

      • roleId string

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

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

      • 状態 string

        サービス アカウントのプロビジョニング ステータス

        値は、IN_PROGRESSCOMPLETEFAILED、または NOT_INITIATED です。

      • atlasAWSAccountArn string

        MongoDB Cloud が IAM(Identity and Access Management、ID とアクセス管理)ロールを引き受けるときに使用するAmazon Web Services (AWS )ユーザーアカウントを識別するAmazonリソース名。

        最小長は 20、最大長は 2048 です。

      • atlasAssumedRoleInitialId string(uuid)

        MongoDB Cloud がAmazon Web Services (AWS )アカウントで IAM ロールを引き受けるときに使用する一意の外部ID 。

      • authorizedDate string(date-time)

        指定されたクラウドサービス プロバイダーに対してこのロールを許可した日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

      • iamAssumedRoleArn string

        MongoDB Cloud が AWS アカウントのリソースにアクセスするときに引き受ける AWS(Amazon Web Services)ID と IAM(Identity and Access Management、ID とアクセス管理)ロールを識別する、ARN(Amazon Resource Name、Amazon リソース ネーム)です。

        最小長は 20、最大長は 2048 です。

    • azureServicePrincipals array[オブジェクト]

      MongoDB Cloud に登録されたAzureサービス プリンシパルが格納されたリスト。

      azureServicePrincipals 属性を非表示にする azureServicePrincipals 属性の表示 オブジェクト

      Azure Service Principal にリンクされた機能を説明する詳細。

      • providerName string 必須 弁別子

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

      • atlasAWSAccountArn string

        MongoDB Cloud が IAM(Identity and Access Management、ID とアクセス管理)ロールを引き受けるときに使用するAmazon Web Services (AWS )ユーザーアカウントを識別するAmazonリソース名。

        最小長は 20、最大長は 2048 です。

      • atlasAssumedRoleInitialId string(uuid)

        MongoDB Cloud がAmazon Web Services (AWS )アカウントで IAM ロールを引き受けるときに使用する一意の外部ID 。

      • authorizedDate string(date-time)

        指定されたクラウドサービス プロバイダーに対してこのロールを許可した日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

      • createdDate string(date-time)

        このAzureサービス プリンシパルが作成された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

      • featureUsages array[オブジェクト]

        このAzureサービス プリンシパルに関連付けられているアプリケーション機能が格納されているリスト。

        次の 1 つ:
      • iamAssumedRoleArn string

        MongoDB Cloud が AWS アカウントのリソースにアクセスするときに引き受ける AWS(Amazon Web Services)ID と IAM(Identity and Access Management、ID とアクセス管理)ロールを識別する、ARN(Amazon Resource Name、Amazon リソース ネーム)です。

        最小長は 20、最大長は 2048 です。

      • roleId string

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

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

      • gcpServiceAccountForAtlas string

        Atlas によって作成された Google サービス アカウントのメールアドレス。

        形式は次のパターンと一致する必要があります: ^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$

      • 状態 string

        サービス アカウントのプロビジョニング ステータス

        値は、IN_PROGRESSCOMPLETEFAILED、または NOT_INITIATED です。

      • _id string

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

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

      • atlasAzureAppId string(uuid)

        Atlas のAzure Active Directory アプリケーションID 。このフィールドは任意であり、指定しない場合はAzureサブスクリプションから取得されます。

      • lastUpdatedDate string(date-time)

        このAzure Service Principal が最後に更新された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

      • servicePrincipalId string(uuid)

        Azureサービス プリンシパルを識別する UUID 文字列。

      • tenantId string(uuid)

        Azure Active Directory テナントIDを識別する UUID 文字列。

    • gcpServiceAccounts array[オブジェクト]

      MongoDB Cloud に登録および認可された Google サービス アカウントが格納されたリスト。

      gcpServiceAccounts 属性を非表示にする gcpServiceAccounts 属性の表示 オブジェクト

      GCPサービス アカウントにリンクされた機能を説明する詳細。

      • providerName string 必須 弁別子

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

      • atlasAWSAccountArn string

        MongoDB Cloud が IAM(Identity and Access Management、ID とアクセス管理)ロールを引き受けるときに使用するAmazon Web Services (AWS )ユーザーアカウントを識別するAmazonリソース名。

        最小長は 20、最大長は 2048 です。

      • atlasAssumedRoleInitialId string(uuid)

        MongoDB Cloud がAmazon Web Services (AWS )アカウントで IAM ロールを引き受けるときに使用する一意の外部ID 。

      • authorizedDate string(date-time)

        指定されたクラウドサービス プロバイダーに対してこのロールを許可した日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

      • createdDate string(date-time)

        この Google サービス アカウントが作成された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

      • featureUsages array[オブジェクト]

        この Google サービス アカウントに関連付けられたアプリケーション機能を格納したリスト。

        次の 1 つ:
      • iamAssumedRoleArn string

        MongoDB Cloud が AWS アカウントのリソースにアクセスするときに引き受ける AWS(Amazon Web Services)ID と IAM(Identity and Access Management、ID とアクセス管理)ロールを識別する、ARN(Amazon Resource Name、Amazon リソース ネーム)です。

        最小長は 20、最大長は 2048 です。

      • roleId string

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

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

      • _id string

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

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

      • atlasAzureAppId string(uuid)

        Atlas のAzure Active Directory アプリケーションID 。このフィールドは任意であり、指定しない場合はAzureサブスクリプションから取得されます。

      • lastUpdatedDate string(date-time)

        このAzure Service Principal が最後に更新された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

      • servicePrincipalId string(uuid)

        Azureサービス プリンシパルを識別する UUID 文字列。

      • tenantId string(uuid)

        Azure Active Directory テナントIDを識別する UUID 文字列。

      • gcpServiceAccountForAtlas string

        Atlas によって作成された Google サービス アカウントのメールアドレス。

        形式は次のパターンと一致する必要があります: ^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$

      • 状態 string

        サービス アカウントのプロビジョニング ステータス

        値は、IN_PROGRESSCOMPLETEFAILED、または NOT_INITIATED です。

  • 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

      このエラーで返されたアプリケーション エラー メッセージ。

GET /API/Atlas/v1.0/groups/{groupId}/cloudProviderAccess
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/cloudProviderAccess' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
応答の例(200)
{
  "awsIamRoles": [
    {
      "providerName": "CloudProviderAccessRole",
      "_id": "32b6e34b3d91647abb20e7b8",
      "atlasAzureAppId": "string",
      "createdDate": "2026-05-04T09:42:00Z",
      "featureUsages": [
        {
          "featureType": "ATLAS_DATA_LAKE",
          "featureId": {
            "groupId": "32b6e34b3d91647abb20e7b8",
            "name": "string"
          }
        }
      ],
      "lastUpdatedDate": "2026-05-04T09:42:00Z",
      "servicePrincipalId": "string",
      "tenantId": "string",
      "gcpServiceAccountForAtlas": "string",
      "roleId": "32b6e34b3d91647abb20e7b8",
      "status": "IN_PROGRESS",
      "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
      "atlasAssumedRoleExternalId": "string",
      "authorizedDate": "2026-05-04T09:42:00Z",
      "iamAssumedRoleArn": "arn:aws:iam::123456789012:root"
    }
  ],
  "azureServicePrincipals": [
    {
      "providerName": "string",
      "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
      "atlasAssumedRoleExternalId": "string",
      "authorizedDate": "2026-05-04T09:42:00Z",
      "createdDate": "2026-05-04T09:42:00Z",
      "featureUsages": [
        {
          "featureType": "ATLAS_DATA_LAKE",
          "featureId": {
            "groupId": "32b6e34b3d91647abb20e7b8",
            "name": "string"
          }
        }
      ],
      "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
      "roleId": "32b6e34b3d91647abb20e7b8",
      "gcpServiceAccountForAtlas": "string",
      "status": "IN_PROGRESS",
      "_id": "32b6e34b3d91647abb20e7b8",
      "atlasAzureAppId": "string",
      "lastUpdatedDate": "2026-05-04T09:42:00Z",
      "servicePrincipalId": "string",
      "tenantId": "string"
    }
  ],
  "gcpServiceAccounts": [
    {
      "providerName": "string",
      "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
      "atlasAssumedRoleExternalId": "string",
      "authorizedDate": "2026-05-04T09:42:00Z",
      "createdDate": "2026-05-04T09:42:00Z",
      "featureUsages": [
        {
          "featureType": "ATLAS_DATA_LAKE",
          "featureId": {
            "groupId": "32b6e34b3d91647abb20e7b8",
            "name": "string"
          }
        }
      ],
      "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
      "roleId": "32b6e34b3d91647abb20e7b8",
      "_id": "32b6e34b3d91647abb20e7b8",
      "atlasAzureAppId": "string",
      "lastUpdatedDate": "2026-05-04T09:42:00Z",
      "servicePrincipalId": "string",
      "tenantId": "string",
      "gcpServiceAccountForAtlas": "string",
      "status": "IN_PROGRESS"
    }
  ]
}
応答の例(401)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}
応答の例(403)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}
応答の例(404)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "error": 404,
  "errorCode": "RESOURCE_NOT_FOUND",
  "reason": "Not Found"
}
応答の例(500)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}