publicación /api/atlas/v1.0/orgs

Crea una organización en MongoDB Cloud y la vincula a la organización de la cuenta de servicio o la clave API solicitante. Para utilizar este recurso, la cuenta de servicio solicitante o la clave de API debe tener el rol de propietario de la organización. La organización de la Cuenta de Servicio o la clave API que solicita debe ser una organización pagante. Para obtener más información, consulta Configurar una organización pagadora en la documentación de MongoDB Atlas. Opcionalmente, si se proporciona federationSettingsId, la nueva Organización estará vinculada a la federación. La cuenta de servicio o clave API de solicitud debe ser el propietario de la organización en la federación.

Configure una organización de pago

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

Organización que deseas crear.

  • clave API Objeto

    Cuenta de servicio de organización que Atlas crea para esta organización. Si se omite, Atlas no crea una cuenta de servicio de la organización para esta organización. Si se especifica, este objeto requiere todos los parámetros del cuerpo. Ten en cuenta que no se pueden especificar claves API en la misma solicitud.

    Ocultar atributos de apiKey Mostrar los atributos de apiKey Objeto
    • desc string Requerido

      Propósito o explicación proporcionados cuando alguien creó esta clave API de la organización.

      La longitud mínima es de 1, la longitud máxima es de 250.

    • Roles array[string] Requerido

      Lista de roles para otorgar a esta clave API. Si proporciona esta lista, proporcione un mínimo de un rol y asegúrese de que cada rol se aplique a esta organización.

      Al menos 1 elemento. 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.

  • federationSettingsId string

    string única de 24 dígitos hexadecimales que identifica la federación a la que se vinculará la organización recién creada. Si se especifica, el propietario propuesto de la nueva organización debe tener el rol de propietario de organización en una organización asociada con la federación.

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

  • Nombre string Requerido

    Etiqueta legible para humanos que identifica la organización.

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

  • orgOwnerId string

    Una única string de 24 dígitos hexadecimales que identifica al usuario de MongoDB Cloud al que deseas asignar el rol de Propietario de la organización. Este usuario debe ser miembro de la misma organización que la clave de API que realiza la llamada. Si proporcionas federationSettingsId, este usuario debe tener el rol de propietario de la organización en una organización dentro de la federación especificada. Este parámetro sólo es necesario si se autentica con claves API programáticas.

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

  • Cuenta de servicio Objeto

    Cuenta de servicio de organización que Atlas crea para esta organización. Si se omite, Atlas no crea una cuenta de servicio de la organización para esta organización. Si se especifica, este objeto requiere todos los parámetros del cuerpo. Ten en cuenta que no se pueden especificar claves API en la misma solicitud.

    Ocultar atributos de serviceAccount Mostrar atributos del serviceAccount Objeto
    • Descripción string Requerido

      Descripción legible para humanos de la cuenta de servicio.

      La longitud mínima es 1 y la máxima es 250. El formato debe coincidir con el siguiente patrón: ^[\p{L}\p{N}\-_.,' ]*$.

    • Nombre string Requerido

      Nombre legible por humanos para la Cuenta de Servicio. El nombre es modificable y no tiene que ser único.

      La longitud mínima es 1 y la máxima es 64. El formato debe coincidir con el siguiente patrón: ^[\p{L}\p{N}\-_.,' ]*$.

    • Roles array[string] Requerido

      Una lista de roles a nivel de organización para la cuenta de servicio.

      Al menos 1 elemento. Los valores son ORG_MEMBER, ORG_READ_ONLY, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_STREAM_PROCESSING_ADMIN, ORG_GROUP_CREATOR o ORG_OWNER.

    • el secreto expira después del horario integer(int32) Requerido

      El vencimiento del nuevo secret de Service Account, proporcionado en horas. Los periodos mínimos y máximos permitidos de expiración están sujetos a cambios y se controlan mediante la configuración de la organización.

  • skipDefaultAlertsSettings booleano

    Desactiva la creación automática de alertas. Si se establece como "verdadero", no se crearán alertas a nivel de organización automáticamente.

    El valor por defecto es false.

Respuestas

  • 201 aplicación/json

    Creado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • clave API Objeto

      Detalles de las claves API programables.

      Ocultar atributos de apiKey Mostrar los atributos de apiKey Objeto
      • desc string

        Propósito o explicación proporcionados cuando alguien creó esta clave API de la organización.

        La longitud mínima es de 1, la longitud máxima es de 250.

      • ID string

        string única de dígitos 24-hexadecimales que identifica esta clave de API de la organización asignada a este Proyecto.

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

      • clave privada string

        Se devolvió una clave privada redactada para esta clave API de organización. Esta clave se muestra sin redactar al crearse.

      • publicKey string

        llave pública de API establecida para la clave API de la organización especificada.

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

      • Roles arreglo[objeto]

        Lista que contiene los roles que la clave de API debe tener. Todos los roles que proporciones deben ser válidos para el proyecto u organización especificada. Cada solicitud debe incluir al menos un rol válido. El recurso devuelve todos los roles de proyecto y de organización asignados a la clave de API.

        Hide roles attributes Mostrar atributos de roles Objeto

        Los roles del usuario de MongoDB Cloud y la organización o el proyecto correspondiente al que se aplica ese rol. Cada rol puede aplicarse a una organización o un proyecto, pero no a ambos.

        Roles de claves de API de MongoDB Cloud
        • ID del grupo string

          string de dígitos hexadecimales 24-única que identifica el Proyecto al que pertenece este rol. Puedes establecer un valor para este parámetro o orgId, pero no ambos en la misma solicitud.

          La longitud mínima es 24 y la máxima es 24. El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

        • orgId string

          Cadena única de dígitos hexadecimales 24que identifica la organización a la que pertenece este rol. Puede establecer un valor para este parámetro o groupId, pero no ambos, en la misma solicitud.

          La longitud mínima es 24 y la máxima es 24. El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

        • nombreDelRol string

          Etiqueta legible por humanos que identifica la colección de privilegios que MongoDB Cloud otorga a una clave API específica, a un usuario de MongoDB Cloud o a un equipo de MongoDB Cloud. Estos roles incluyen roles a nivel de organización y de proyecto.

          Roles de usuario de MongoDB Cloud
    • federationSettingsId string

      string de dígitos hexadecimales única de 24que identifica la federación a la que vinculaste la organización recién creada.

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

    • orgOwnerId string

      Cadena de dígitos hexadecimales 24única que identifica al usuario de MongoDB Cloud al que le asignó el rol de Propietario de la organización en la nueva organización.

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

    • organización Objeto

      Detalles que describen la organización.

      Ocultar atributos de la organización Mostrar atributos de organización Objeto
      • ID 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})$.

      • isDeleted booleano

        Indicador que señala si esta organización ha sido borrada.

      • Nombre string Requerido

        Etiqueta legible para humanos que identifica la organización.

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

      • skipDefaultAlertsSettings booleano

        Desactiva la creación automática de alertas. Si se establece como "verdadero", no se crearán alertas a nivel de organización automáticamente.

        El valor por defecto es false.

    • Cuenta de servicio Objeto

      Cuenta de servicio de la organización que Atlas creó para la organización.

      Ocultar atributos de serviceAccount Mostrar atributos del serviceAccount Objeto
      • ID de cliente string

        El ID de cliente de la cuenta de servicio.

        El formato debe coincidir con el siguiente patrón: ^mdb_sa_id_[a-fA-F\d]{24}$.

      • creado a las string(date-time)

        La fecha en que se creó la Cuenta de Servicio. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • Descripción string

        Descripción legible para humanos de la cuenta de servicio.

      • Nombre string

        Nombre legible por humanos para la cuenta de servicio.

      • Roles array[string]

        Una lista de roles de la organización asociados con la cuenta de servicio.

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

      • Secretos arreglo[objeto]

        Lista de secretos asociados con la cuenta de servicio especificada.

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

          La fecha en que se creó el secreto. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

        • expira en string(date-time) Requerido

          Fecha de vencimiento del secreto. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

        • ID string Requerido

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

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

        • lastUsedAt string(date-time)

          La última vez que se usó el secreto. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

        • maskedSecretValue string

          El secreto de la cuenta de servicio enmascarado.

        • secreto string

          El secreto para la cuenta de servicio. Se devolverá sólo la primera vez después de su creación.

    • skipDefaultAlertsSettings booleano

      Desactiva la creación automática de alertas. Si se establece como "verdadero", no se crearán alertas a nivel de organización automáticamente.

      El valor por defecto es false.

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

  • 409 aplicación/json

    Conflicto.

    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.

POST /api/atlas/v1.0/orgs
curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v1.0/orgs' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"apiKey":{"desc":"string","roles":["ORG_OWNER"]},"federationSettingsId":"32b6e34b3d91647abb20e7b8","name":"string","orgOwnerId":"32b6e34b3d91647abb20e7b8","serviceAccount":{"description":"string","name":"string","roles":["ORG_MEMBER"],"secretExpiresAfterHours":8},"skipDefaultAlertsSettings":false}'
Solicitar ejemplos
{
  "apiKey": {
    "desc": "string",
    "roles": [
      "ORG_OWNER"
    ]
  },
  "federationSettingsId": "32b6e34b3d91647abb20e7b8",
  "name": "string",
  "orgOwnerId": "32b6e34b3d91647abb20e7b8",
  "serviceAccount": {
    "description": "string",
    "name": "string",
    "roles": [
      "ORG_MEMBER"
    ],
    "secretExpiresAfterHours": 8
  },
  "skipDefaultAlertsSettings": false
}
Ejemplos de respuestas (201)
{
  "apiKey": {
    "desc": "string",
    "id": "32b6e34b3d91647abb20e7b8",
    "links": [
      {
        "href": "https://cloud.mongodb.com/api/atlas",
        "rel": "self"
      }
    ],
    "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
    "publicKey": "zmmrboas",
    "roles": [
      {
        "groupId": "32b6e34b3d91647abb20e7b8",
        "orgId": "32b6e34b3d91647abb20e7b8",
        "roleName": "string"
      }
    ]
  },
  "federationSettingsId": "32b6e34b3d91647abb20e7b8",
  "orgOwnerId": "32b6e34b3d91647abb20e7b8",
  "organization": {
    "id": "32b6e34b3d91647abb20e7b8",
    "isDeleted": true,
    "links": [
      {
        "href": "https://cloud.mongodb.com/api/atlas",
        "rel": "self"
      }
    ],
    "name": "string",
    "skipDefaultAlertsSettings": false
  },
  "serviceAccount": {
    "clientId": "mdb_sa_id_1234567890abcdef12345678",
    "createdAt": "2026-05-04T09:42:00Z",
    "description": "string",
    "name": "string",
    "roles": [
      "ORG_MEMBER"
    ],
    "secrets": [
      {
        "createdAt": "2026-05-04T09:42:00Z",
        "expiresAt": "2026-05-04T09:42:00Z",
        "id": "32b6e34b3d91647abb20e7b8",
        "lastUsedAt": "2026-05-04T09:42:00Z",
        "maskedSecretValue": "mdb_sa_sk_...",
        "secret": "mdb_sa_sk_..."
      }
    ]
  },
  "skipDefaultAlertsSettings": false
}
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 (409)
{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}
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"
}