Agregar un usuario de MongoDB Cloud a un proyecto Obsoleto

PUBLICAR /api/atlas/v2/grupos/{ID de grupo}/acceso

Añade un usuario de MongoDB Cloud al proyecto especificado. Si el usuario de MongoDB Cloud no es miembro de la organización del proyecto, debe aceptar la invitación para acceder a la información del proyecto. Si ya es miembro de la organización, se añadirá al proyecto inmediatamente y este recurso no devolverá la invitación. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de administrador de usuarios de grupo.

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

  • bonita booleano

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

    El valor predeterminado es false.

    Impresión bonita
  • 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.

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

Cuerpo Requerido

Agrega un usuario de MongoDB Cloud al proyecto especificado.

  • papeles array[string]

    Uno o más roles de nivel de proyecto para asignar al usuario de MongoDB Cloud.

  • Nombre de usuario cadena(correo electrónico)

    Dirección de correo electrónico del usuario de MongoDB Cloud invitado al proyecto especificado.

Respuestas

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

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • creadoEn cadena(fecha-hora)

      Fecha y hora en que MongoDB Cloud envió la invitación. MongoDB Cloud representa esta marca de tiempo en formato ISO 8601 en UTC.

    • expira en cadena(fecha-hora)

      Fecha y hora de vencimiento de la invitación de MongoDB Cloud. MongoDB Cloud representa esta marca de tiempo en formato ISO 8601 en UTC.

    • Asignaciones de roles de grupo matriz[objeto]

      Lista de proyectos a los que se añadirá al usuario cuando acepte su invitación a la organización.

      Ocultar atributos de groupRoleAssignments Mostrar atributos de groupRoleAssignments Objeto
      • ID de grupo string

        Cadena de dígitos hexadecimales 24única que identifica el proyecto al que pertenece este rol.

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

      • rol de grupo string

        Etiqueta legible que identifica el conjunto de privilegios que MongoDB Cloud otorga a una clave API, un usuario o un equipo de MongoDB Cloud específicos. Estos roles incluyen roles a nivel de proyecto.

        Roles de usuario de MongoDB Cloud
    • ID. string

      Cadena de dígitos hexadecimales 24única que identifica esta invitación.

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

    • inviterUsername cadena(correo electrónico)

      Dirección de correo electrónico del usuario de MongoDB Cloud que envió la invitación para unirse a la organización.

    • orgId string

      Cadena de dígitos hexadecimales 24única que identifica a la organización.

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

    • nombre_org string Requerido

      Etiqueta legible por humanos que identifica a esta organización.

      El formato debe coincidir con el siguiente patrón: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$.

    • papeles array[string]

      Uno o más roles a nivel de organización para asignar al usuario de MongoDB Cloud.

      Los valores son ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_STREAM_PROCESSING_ADMIN o ORG_READ_ONLY.

    • ID de equipo array[string]

      Lista de cadenas de dígitos hexadecimales 24únicos que identifican a cada equipo.

    • Nombre de usuario cadena(correo electrónico)

      Dirección de correo electrónico del usuario de MongoDB Cloud invitado a unirse a la organización.

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

    Sin contenido

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

POST /api/atlas/v2/grupos/{groupId}/acceso
atlas api projects addGroupUser --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20231115001/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.AddGroupAccessUserApiParams{}
	sdkResp, httpResp, err := client.ProjectsApi.
		AddGroupAccessUserWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-11-15+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-11-15+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access" \
  -d '{ <Payload> }'
Solicitar ejemplos
{
  "roles": [
    "string"
  ],
  "username": "hello@example.com"
}
Ejemplos de respuestas (200)
{
  "createdAt": "2026-05-04T09:42:00Z",
  "expiresAt": "2026-05-04T09:42:00Z",
  "groupRoleAssignments": [
    {
      "groupId": "32b6e34b3d91647abb20e7b8",
      "groupRole": "string"
    }
  ],
  "id": "32b6e34b3d91647abb20e7b8",
  "inviterUsername": "hello@example.com",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "orgName": "string",
  "roles": [
    "ORG_OWNER"
  ],
  "teamIds": [
    "string"
  ],
  "username": "hello@example.com"
}
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"
}