Devolver todos los roles de acceso del proveedor de la nube

Obtener /api/atlas/v2/grupos/{ID de grupo}/cloudProviderAccess

Devuelve todos los roles de acceso del proveedor de nube con acceso al proyecto especificado. Para usar este recurso, la cuenta de servicio o la clave API solicitante debe tener el rol de propietario del proyecto.

Parámetros de ruta

  • ID de grupo string Requerido

    Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.

    NOTA: Grupos y proyectos son términos sinónimos. El ID de tu grupo es el mismo que el de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos".

    El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

Parámetros de consulta

  • envolvente booleano

    Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.

    El valor predeterminado es false.

  • bonita booleano

    Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.

    El valor predeterminado es false.

    Impresión bonita

Respuestas

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

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Roles de AWS Iam matriz[objeto]

      Lista que contiene los roles IAM de Amazon Web Services (AWS) registrados y autorizados con MongoDB Cloud.

      Detalles que describen las características vinculadas a la función de Administración de acceso e identidad (IAM) de Amazon Web Services (AWS).

      Ocultar atributos de awsIamRoles Mostrar atributos de awsIamRoles Objeto

      Detalles que describen las características vinculadas a la función de Administración de acceso e identidad (IAM) de Amazon Web Services (AWS).

      • nombreProveedor string Requerido Discriminado

        Etiqueta legible por humanos que identifica al proveedor de nube del rol.

        El valor es CloudProviderAccessRole.

      • _id string

        Cadena de dígitos hexadecimales 24única que identifica el rol.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • ID de aplicación de Atlas Azure cadena(uuid)

        Id. de la aplicación de Azure Active Directory de Atlas. Este campo es opcional y, si no se proporciona, se derivará de la suscripción de Azure.

      • fecha de creación cadena(fecha-hora)

        Fecha y hora en que alguien creó este rol para el proveedor de servicios en la nube especificado. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • Usos de funciones matriz[objeto]

        Lista que contiene las características de la aplicación asociadas con esta función de administración de acceso e identidad (IAM) de Amazon Web Services (AWS).

        Uno de:
      • lastUpdatedDate cadena(fecha-hora)

        Fecha y hora de la última actualización de esta entidad de servicio de Azure. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • ID principal del servicio cadena(uuid)

        Cadena UUID que identifica la entidad de servicio de Azure.

      • ID de inquilino cadena(uuid)

        Cadena UUID que identifica el identificador del inquilino de Azure Active Directory.

      • Cuenta de servicio gcp para Atlas string

        Dirección de correo electrónico de la cuenta de servicio de Google creada por Atlas.

        El formato debe coincidir con el siguiente patrón: ^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$.

      • roleId string

        Cadena de dígitos hexadecimales 24única que identifica el rol.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • Estado string

        Estado de provisión de la cuenta de servicio.

        Los valores son IN_PROGRESS, COMPLETE, FAILED o NOT_INITIATED.

      • CuentaAtlasAWSARN string

        Nombre de recurso de Amazon que identifica la cuenta de usuario de Amazon Web Services (AWS) que MongoDB Cloud utiliza cuando asume el rol de Administración de identidad y acceso (IAM).

        La longitud mínima es 20, la longitud máxima es 2048.

      • ID externo del rol asumido de atlas cadena(uuid)

        Identificador externo único que utiliza MongoDB Cloud cuando asume el rol de IAM en su cuenta de Amazon Web Services (AWS).

      • authorizedDate cadena(fecha-hora)

        Fecha y hora en que alguien autorizó este rol para el proveedor de servicios en la nube especificado. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • iamAssumedRoleArn string

        Nombre de recurso de Amazon (ARN) que identifica la función de administración de acceso e identidad (IAM) de Amazon Web Services (AWS) que MongoDB Cloud asume cuando accede a los recursos de su cuenta de AWS.

        La longitud mínima es 20, la longitud máxima es 2048.

    • Principales de servicio de Azure matriz[objeto]

      Lista que contiene las entidades de servicio de Azure registradas con MongoDB Cloud.

      Detalles que describen las características vinculadas a la entidad de servicio de Azure.

      Ocultar atributos de azureServicePrincipals Mostrar atributos de azureServicePrincipals Objeto

      Detalles que describen las características vinculadas a la entidad de servicio de Azure.

      • nombreProveedor string Requerido Discriminado

        Etiqueta legible por humanos que identifica al proveedor de nube del rol.

      • CuentaAtlasAWSARN string

        Nombre de recurso de Amazon que identifica la cuenta de usuario de Amazon Web Services (AWS) que MongoDB Cloud utiliza cuando asume el rol de Administración de identidad y acceso (IAM).

        La longitud mínima es 20, la longitud máxima es 2048.

      • ID externo del rol asumido de atlas cadena(uuid)

        Identificador externo único que utiliza MongoDB Cloud cuando asume el rol de IAM en su cuenta de Amazon Web Services (AWS).

      • authorizedDate cadena(fecha-hora)

        Fecha y hora en que alguien autorizó este rol para el proveedor de servicios en la nube especificado. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • fecha de creación cadena(fecha-hora)

        Fecha y hora de creación de esta entidad de servicio de Azure. Este parámetro expresa su valor en formato de marca de tiempo ISO 8601 en UTC.

      • Usos de funciones matriz[objeto]

        Lista que contiene características de la aplicación asociadas con esta entidad de servicio de Azure.

        Uno de:
      • iamAssumedRoleArn string

        Nombre de recurso de Amazon (ARN) que identifica la función de administración de acceso e identidad (IAM) de Amazon Web Services (AWS) que MongoDB Cloud asume cuando accede a los recursos de su cuenta de AWS.

        La longitud mínima es 20, la longitud máxima es 2048.

      • roleId string

        Cadena de dígitos hexadecimales 24única que identifica el rol.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • Cuenta de servicio gcp para Atlas string

        Dirección de correo electrónico de la cuenta de servicio de Google creada por Atlas.

        El formato debe coincidir con el siguiente patrón: ^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$.

      • Estado string

        Estado de provisión de la cuenta de servicio.

        Los valores son IN_PROGRESS, COMPLETE, FAILED o NOT_INITIATED.

      • _id string

        Cadena de dígitos hexadecimales 24única que identifica el rol.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • ID de aplicación de Atlas Azure cadena(uuid)

        Id. de la aplicación de Azure Active Directory de Atlas. Este campo es opcional y, si no se proporciona, se derivará de la suscripción de Azure.

      • lastUpdatedDate cadena(fecha-hora)

        Fecha y hora de la última actualización de esta entidad de servicio de Azure. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • ID principal del servicio cadena(uuid)

        Cadena UUID que identifica la entidad de servicio de Azure.

      • ID de inquilino cadena(uuid)

        Cadena UUID que identifica el identificador del inquilino de Azure Active Directory.

    • Cuentas de servicio gcp matriz[objeto]

      Lista que contiene las cuentas de servicio de Google registradas y autorizadas con MongoDB Cloud.

      Detalles que describen las características vinculadas a la cuenta de servicio de GCP.

      Ocultar atributos de gcpServiceAccounts Mostrar atributos de gcpServiceAccounts Objeto

      Detalles que describen las características vinculadas a la cuenta de servicio de GCP.

      • nombreProveedor string Requerido Discriminado

        Etiqueta legible por humanos que identifica al proveedor de nube del rol.

      • CuentaAtlasAWSARN string

        Nombre de recurso de Amazon que identifica la cuenta de usuario de Amazon Web Services (AWS) que MongoDB Cloud utiliza cuando asume el rol de Administración de identidad y acceso (IAM).

        La longitud mínima es 20, la longitud máxima es 2048.

      • ID externo del rol asumido de atlas cadena(uuid)

        Identificador externo único que utiliza MongoDB Cloud cuando asume el rol de IAM en su cuenta de Amazon Web Services (AWS).

      • authorizedDate cadena(fecha-hora)

        Fecha y hora en que alguien autorizó este rol para el proveedor de servicios en la nube especificado. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • fecha de creación cadena(fecha-hora)

        Fecha y hora en que se creó esta Cuenta de Servicio de Google. Este parámetro expresa su valor en el formato de timestamp ISO 8601 en UTC.

      • Usos de funciones matriz[objeto]

        Lista que contiene las funciones de la aplicación asociadas con esta cuenta de servicio de Google.

        Uno de:
      • iamAssumedRoleArn string

        Nombre de recurso de Amazon (ARN) que identifica la función de administración de acceso e identidad (IAM) de Amazon Web Services (AWS) que MongoDB Cloud asume cuando accede a los recursos de su cuenta de AWS.

        La longitud mínima es 20, la longitud máxima es 2048.

      • roleId string

        Cadena de dígitos hexadecimales 24única que identifica el rol.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • _id string

        Cadena de dígitos hexadecimales 24única que identifica el rol.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • ID de aplicación de Atlas Azure cadena(uuid)

        Id. de la aplicación de Azure Active Directory de Atlas. Este campo es opcional y, si no se proporciona, se derivará de la suscripción de Azure.

      • lastUpdatedDate cadena(fecha-hora)

        Fecha y hora de la última actualización de esta entidad de servicio de Azure. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • ID principal del servicio cadena(uuid)

        Cadena UUID que identifica la entidad de servicio de Azure.

      • ID de inquilino cadena(uuid)

        Cadena UUID que identifica el identificador del inquilino de Azure Active Directory.

      • Cuenta de servicio gcp para Atlas string

        Dirección de correo electrónico de la cuenta de servicio de Google creada por Atlas.

        El formato debe coincidir con el siguiente patrón: ^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$.

      • Estado string

        Estado de provisión de la cuenta de servicio.

        Los valores son IN_PROGRESS, COMPLETE, FAILED o NOT_INITIATED.

  • 401 aplicación/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 403 aplicación/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 404 aplicación/json

    No se encontró.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 500 aplicación/json

    Error Interno del Servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

OBTENER /api/atlas/v2/groups/{groupId}/cloudProviderAccess
atlas api cloudProviderAccess listCloudProviderAccess --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20231001001/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.2023-10-01+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.2023-10-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true"
Ejemplos de respuestas (200)
{
  "awsIamRoles": [
    {
      "providerName": "CloudProviderAccessRole",
      "_id": "32b6e34b3d91647abb20e7b8",
      "atlasAzureAppId": "string",
      "createdDate": "2026-05-04T09:42:00Z",
      "featureUsages": [
        {
          "featureType": "ATLAS_DATA_LAKE",
          "featureId": {}
        }
      ],
      "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"
    }
  ]
}
Ejemplos de respuestas (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"
}
Ejemplos de respuestas (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"
}
Ejemplos de respuestas (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"
}
Ejemplos de respuestas (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"
}