Retornar todas as funções de acesso do fornecedor de nuvem

OBTER /api/atlas/v2/groups/{groupId}/cloudProviderAccess

Retorna todas as funções de acesso do provedor de nuvem com acesso ao projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário do projeto.

parâmetros de caminho

  • groupId string Obrigatório

    Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.

    AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

parâmetros de query

  • envelope booleano

    Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.

    O valor padrão é false.

  • pretty booleano

    Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

    O valor padrão é false.

    Prettyprint

Respostas

  • 200 application/vnd.atlas.2023-01-01+json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • awsIamRoles array[objeto]

      Lista que contém as funções do Amazon Web Services (AWS) IAM registradas e autorizadas no MongoDB Cloud.

      Detalhes que descrevem os recursos vinculados à função Amazon Web Services (AWS) Identity e Access Management (IAM).

      Ocultar atributos awsIamRoles Mostrar atributos awsIamRoles objeto

      Detalhes que descrevem os recursos vinculados à função Amazon Web Services (AWS) Identity e Access Management (IAM).

      • providerName string Obrigatório Discriminador

        Rótulo legível por humanos que identifica o fornecedor de nuvem da função.

        O valor é CloudProviderAccessRole.

      • _id string

        String única de 24 dígitos hexadecimais que identifica a role.

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • atlasAzureAppId string(uuid)

        ID de aplicação do Azure Active Directory do Atlas.

      • createdDate string(data-hora)

        Data e hora em que alguém criou esta role para o provedor de serviços de nuvem especificado. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • featureUsages array[objeto]

        Lista que contém recursos de aplicação associados a essa função do Amazon Web Services (AWS) Identity and Access Management (IAM).

        Um dos seguintes:
      • lastUpdatedDate string(data-hora)

        Data e hora em que este Service Principal do Azure foi atualizado pela última vez. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • ID do Principal de Serviços string(uuid)

        String UUID que identifica o Azure Service Principal.

      • ID do Inquilino string(uuid)

        String de UUID que identifica a ID do inquilino do Azure Active Directory.

      • gcpServiceAccountForAtlas string

        Endereço de e-mail da conta do Google Service criada pelo Atlas.

        O formato deve corresponder ao seguinte padrão: ^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$.

      • roleId string

        String única de 24 dígitos hexadecimais que identifica a role.

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • Status string

        Status de provisionamento da conta de serviço.

        Os valores são IN_PROGRESS, COMPLETE, FAILED ou NOT_INITIATED.

      • atlasAWSAccountArn string

        Nome do recurso da Amazon que identifica a conta de usuário do Amazon Web Services (AWS) que o MongoDB Cloud usa quando assume a função de gerenciamento de identidade e acesso (IAM).

        O comprimento mínimo é 20, o comprimento máximo é 2048.

      • atlasAssumedRoleExternalId string(uuid)

        ID externa exclusiva que o MongoDB Cloud usa quando assume a função IAM em sua conta da Amazon Web Services (AWS).

      • authorizedDate string(data-hora)

        Data e hora em que alguém autorizou esta função para o provedor de serviços de nuvem especificado. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • iamAssumedRoleArn string

        Nome de recurso da Amazon (ARN) que identifica a função de gerenciamento de identidade e acesso (IAM) do Amazon Web Services (AWS) que o MongoDB Cloud considera quando acessa recursos em sua conta da AWS.

        O comprimento mínimo é 20, o comprimento máximo é 2048.

    • azureService Principals array[objeto]

      Lista que contém as entidades de serviço do Azure registradas no MongoDB Cloud.

      Detalhes que descrevem as funcionalidades vinculadas ao Azure Service Principal.

      Ocultar atributos azureService Principals Mostrar atributos azureService Principals objeto

      Detalhes que descrevem as funcionalidades vinculadas ao Azure Service Principal.

      • providerName string Obrigatório Discriminador

        Rótulo legível por humanos que identifica o fornecedor de nuvem da função.

      • atlasAWSAccountArn string

        Nome do recurso da Amazon que identifica a conta de usuário do Amazon Web Services (AWS) que o MongoDB Cloud usa quando assume a função de gerenciamento de identidade e acesso (IAM).

        O comprimento mínimo é 20, o comprimento máximo é 2048.

      • atlasAssumedRoleExternalId string(uuid)

        ID externa exclusiva que o MongoDB Cloud usa quando assume a função IAM em sua conta da Amazon Web Services (AWS).

      • authorizedDate string(data-hora)

        Data e hora em que alguém autorizou esta função para o provedor de serviços de nuvem especificado. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • createdDate string(data-hora)

        Data e hora em que este Service Principal do Azure foi criado. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • featureUsages array[objeto]

        Lista que contém funcionalidades de aplicação associadas a esse Azure Service Principal.

        Um dos seguintes:
      • iamAssumedRoleArn string

        Nome de recurso da Amazon (ARN) que identifica a função de gerenciamento de identidade e acesso (IAM) do Amazon Web Services (AWS) que o MongoDB Cloud considera quando acessa recursos em sua conta da AWS.

        O comprimento mínimo é 20, o comprimento máximo é 2048.

      • roleId string

        String única de 24 dígitos hexadecimais que identifica a role.

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • gcpServiceAccountForAtlas string

        Endereço de e-mail da conta do Google Service criada pelo Atlas.

        O formato deve corresponder ao seguinte padrão: ^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$.

      • Status string

        Status de provisionamento da conta de serviço.

        Os valores são IN_PROGRESS, COMPLETE, FAILED ou NOT_INITIATED.

      • _id string

        String única de 24 dígitos hexadecimais que identifica a role.

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • atlasAzureAppId string(uuid)

        ID de aplicação do Azure Active Directory do Atlas.

      • lastUpdatedDate string(data-hora)

        Data e hora em que este Service Principal do Azure foi atualizado pela última vez. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • ID do Principal de Serviços string(uuid)

        String UUID que identifica o Azure Service Principal.

      • ID do Inquilino string(uuid)

        String de UUID que identifica a ID do inquilino do Azure Active Directory.

    • gcpServiceAccounts array[objeto]

      Lista que contém as contas de serviço do Google registradas e autorizadas com o MongoDB Cloud.

      Detalhes que descrevem os recursos vinculados à Conta de Serviço GCP.

      Ocultar atributos gcpServiceAccounts Mostrar atributos do gcpServiceAccounts objeto

      Detalhes que descrevem os recursos vinculados à Conta de Serviço GCP.

      • providerName string Obrigatório Discriminador

        Rótulo legível por humanos que identifica o fornecedor de nuvem da função.

      • atlasAWSAccountArn string

        Nome do recurso da Amazon que identifica a conta de usuário do Amazon Web Services (AWS) que o MongoDB Cloud usa quando assume a função de gerenciamento de identidade e acesso (IAM).

        O comprimento mínimo é 20, o comprimento máximo é 2048.

      • atlasAssumedRoleExternalId string(uuid)

        ID externa exclusiva que o MongoDB Cloud usa quando assume a função IAM em sua conta da Amazon Web Services (AWS).

      • authorizedDate string(data-hora)

        Data e hora em que alguém autorizou esta função para o provedor de serviços de nuvem especificado. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • createdDate string(data-hora)

        Data e hora em que esta conta de serviço do Google foi criada. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • featureUsages array[objeto]

        Lista que contém recursos de aplicação associados a esta conta de serviço do Google.

        Um dos seguintes:
      • iamAssumedRoleArn string

        Nome de recurso da Amazon (ARN) que identifica a função de gerenciamento de identidade e acesso (IAM) do Amazon Web Services (AWS) que o MongoDB Cloud considera quando acessa recursos em sua conta da AWS.

        O comprimento mínimo é 20, o comprimento máximo é 2048.

      • roleId string

        String única de 24 dígitos hexadecimais que identifica a role.

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • _id string

        String única de 24 dígitos hexadecimais que identifica a role.

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • atlasAzureAppId string(uuid)

        ID de aplicação do Azure Active Directory do Atlas.

      • lastUpdatedDate string(data-hora)

        Data e hora em que este Service Principal do Azure foi atualizado pela última vez. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • ID do Principal de Serviços string(uuid)

        String UUID que identifica o Azure Service Principal.

      • ID do Inquilino string(uuid)

        String de UUID que identifica a ID do inquilino do Azure Active Directory.

      • gcpServiceAccountForAtlas string

        Endereço de e-mail da conta do Google Service criada pelo Atlas.

        O formato deve corresponder ao seguinte padrão: ^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$.

      • Status string

        Status de provisionamento da conta de serviço.

        Os valores são IN_PROGRESS, COMPLETE, FAILED ou NOT_INITIATED.

  • 401 aplicação/json

    Não autorizado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 403 aplicação/json

    Forbidden.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 404 aplicação/json

    Não encontrado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 500 aplicação/json

    Erro interno do servidor.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

GET /api/atlas/v2/groups/{groupId}/cloudProviderAccess
atlas api cloudProviderAccess listGroupCloudProviderAccess --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/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.ListGroupCloudProviderAccessApiParams{}
	sdkResp, httpResp, err := client.CloudProviderAccessApi.
		ListGroupCloudProviderAccessWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true"
Exemplos de resposta (200)
{
  "awsIamRoles": [
    {
      "providerName": "CloudProviderAccessRole",
      "_id": "32b6e34b3d91647abb20e7b8",
      "atlasAzureAppId": "string",
      "createdDate": "2025-05-04T09:42:00Z",
      "featureUsages": [
        {
          "featureType": "ATLAS_DATA_LAKE",
          "featureId": {}
        }
      ],
      "lastUpdatedDate": "2025-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": "2025-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": "2025-05-04T09:42:00Z",
      "createdDate": "2025-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": "2025-05-04T09:42:00Z",
      "servicePrincipalId": "string",
      "tenantId": "string"
    }
  ],
  "gcpServiceAccounts": [
    {
      "providerName": "string",
      "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
      "atlasAssumedRoleExternalId": "string",
      "authorizedDate": "2025-05-04T09:42:00Z",
      "createdDate": "2025-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": "2025-05-04T09:42:00Z",
      "servicePrincipalId": "string",
      "tenantId": "string",
      "gcpServiceAccountForAtlas": "string",
      "status": "IN_PROGRESS"
    }
  ]
}
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}