Actualización de la Invitación de una Organización

PATCH /api/atlas/v1.0/orgs/{orgId}/invites

Actualiza los detalles de una invitación pendiente a la organización especificada. Para especificar qué invitación, proporciona el nombre de usuario de la persona invitada. Para utilizar este recurso, la Cuenta de servicio o la clave API que realiza la solicitud debe tener el rol de Propietario/a de la organización.

Parámetros de path

  • orgId string Requerido

    string única de 24dígitos hexadecimales que identifica la organización que contiene su proyectos. Utilice el /orgs endpoint para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso.

    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
aplicación/json

Cuerpo Requerido

Actualiza los detalles de una invitación pendiente para la organización especificada.

  • groupRoleAssignments arreglo[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 del grupo string

      string hexadecimal única de 24dígitos que identifica el Proyecto al que pertenecen estos roles.

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

    • Roles array[string]

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

  • Roles array[string]

    Uno o más roles a nivel de la 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.

  • teamIds array[string]

    Lista de equipos a los que desea invitar al usuario de MongoDB Cloud deseado.

  • Nombre de usuario cadena(correo electrónico)

    Dirección de correo electrónico que pertenece al usuario deseado de MongoDB nube.

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • creado a las string(date-time)

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

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

    • groupRoleAssignments arreglo[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 del grupo string

        Unique 24-hexadecimal digit string that identifica el proyecto al que este rol pertenece.

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

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

      string única de 24dígitos hexadecimales 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 única de 24 dígitos hexadecimales que identifica a la organización.

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

    • orgName 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}$.

    • Roles array[string]

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

      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.

    • teamIds array[string]

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

    • Nombre de usuario cadena(correo electrónico)

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

  • 400 aplicación/json

    Solicitud incorrecta.

    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.

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

PATCH /api/atlas/v1.0/orgs/{orgId}/invites
curl \
 --request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/orgs/4888442a3354817a7320eb61/invites' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"groupRoleAssignments":[{"groupId":"32b6e34b3d91647abb20e7b8","roles":["string"]}],"roles":["ORG_OWNER"],"teamIds":["string"],"username":"hello@example.com"}'
Solicitar ejemplos
{
  "groupRoleAssignments": [
    {
      "groupId": "32b6e34b3d91647abb20e7b8",
      "roles": [
        "string"
      ]
    }
  ],
  "roles": [
    "ORG_OWNER"
  ],
  "teamIds": [
    "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 (400)
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
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"
}