Devuelva todos los roles de acceso del proveedor de nube

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

Devuelve todos los roles de acceso de proveedores 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 path

  • ID del grupo string Requerido

    string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /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 id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.

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

Parámetros de query

  • envelope booleano

    Bandera que indica si la aplicación envuelve 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 remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.

    El valor por defecto es false.

  • bonito booleano

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

    El valor por defecto es false.

    Impresión bonita

Respuestas

  • 200 aplicación/json

    Vale

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

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

      Ocultar atributos de awsIamRoles Mostrar atributos de awsIamRoles Objeto

      Detalles que describen las funcionalidades vinculadas al rol de Identity and Access Management (IAM) de Amazon Web Services (AWS).

      • providerName string Requerido Discriminador

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

        El valor es CloudProviderAccessRole.

      • _id string

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

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

      • atlasAzureAppId 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.

      • createdDate string(date-time)

        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.

      • Uso de funcionalidades arreglo[objeto]

        Lista que contiene las funcionalidades de la aplicación asociadas con este rol de Amazon Web Services (AWS) Identity and Access Management (IAM).

        Uno de:
      • lastUpdatedDate string(date-time)

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

      • IdPrincipalDeServicio cadena(uuid)

        string UUID que identifica el Principal de Servicio de Azure.

      • ID de inquilino cadena(uuid)

        Cadena UUID que identifica el Azure Active Directory Tenant ID.

      • 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

        string única de 24 dígitos hexadecimales 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 de 20, la longitud máxima es de 2048.

      • atlasAssumedRoleExternalId cadena(uuid)

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

      • authorizedDate string(date-time)

        Fecha y hora en las 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

        Amazon Resource Name (ARN) que identifica el rol de Amazon Web Services (AWS) Identity and Access Management (IAM) que MongoDB Cloud asume cuando accede a recursos en tu cuenta de AWS.

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

    • azureServicePrincipals arreglo[objeto]

      Lista que contiene los Principales de Servicio de Azure registrados en MongoDB nube.

      Ocultar atributos de azureServicePrincipals Mostrar atributos de azureServicePrincipals Objeto

      Detalles que describen las funcionalidades vinculadas al Principal de Servicio de Azure.

      • providerName string Requerido Discriminador

        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 de 20, la longitud máxima es de 2048.

      • atlasAssumedRoleExternalId cadena(uuid)

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

      • authorizedDate string(date-time)

        Fecha y hora en las 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.

      • createdDate string(date-time)

        Fecha y hora en que se creó este principal de servicio de Azure. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • Uso de funcionalidades arreglo[objeto]

        Lista que contiene las funcionalidades de la aplicación asociadas a este Azure Service Principal.

        Uno de:
      • iamAssumedRoleArn string

        Amazon Resource Name (ARN) que identifica el rol de Amazon Web Services (AWS) Identity and Access Management (IAM) que MongoDB Cloud asume cuando accede a recursos en tu cuenta de AWS.

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

      • roleId string

        string única de 24 dígitos hexadecimales 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

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

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

      • atlasAzureAppId 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 string(date-time)

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

      • IdPrincipalDeServicio cadena(uuid)

        string UUID que identifica el Principal de Servicio de Azure.

      • ID de inquilino cadena(uuid)

        Cadena UUID que identifica el Azure Active Directory Tenant ID.

    • Cuentas de servicio gcp arreglo[objeto]

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

      Ocultar atributos de gcpServiceAccounts Mostrar atributos de gcpServiceAccounts Objeto

      Detalles que describen las funcionalidades vinculadas a la Cuenta de Servicio de GCP.

      • providerName string Requerido Discriminador

        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 de 20, la longitud máxima es de 2048.

      • atlasAssumedRoleExternalId cadena(uuid)

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

      • authorizedDate string(date-time)

        Fecha y hora en las 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.

      • createdDate string(date-time)

        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.

      • Uso de funcionalidades arreglo[objeto]

        Lista que contiene las funcionalidades de la aplicación asociadas con esta Cuenta de Servicio de Google.

        Uno de:
      • iamAssumedRoleArn string

        Amazon Resource Name (ARN) que identifica el rol de Amazon Web Services (AWS) Identity and Access Management (IAM) que MongoDB Cloud asume cuando accede a recursos en tu cuenta de AWS.

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

      • roleId string

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

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

      • _id string

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

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

      • atlasAzureAppId 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 string(date-time)

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

      • IdPrincipalDeServicio cadena(uuid)

        string UUID que identifica el Principal de Servicio de Azure.

      • ID de inquilino cadena(uuid)

        Cadena UUID que identifica el Azure Active Directory Tenant ID.

      • 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 incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 403 aplicación/json

    Forbidden.

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

      Detalle de solicitud incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve 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 incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve 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 incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

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"
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"
}