PUBLICAR /api/atlas/v2/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 usar este recurso, la Cuenta de Servicio o la Clave API solicitante debe tener el rol de Propietario de la Organización. La organización de la Cuenta de Servicio o la Clave API solicitante debe ser una organización de pago. Para obtener más información, consulte "Configurar una Organización de Pago" en la documentación de MongoDB Atlas. Opcionalmente, si se proporciona federationSettingsId, la nueva organización se vinculará a la federación. La Cuenta de Servicio o la Clave API solicitante debe ser un Propietario de la Organización en la federación.

Configure una organización de pago

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
application/vnd.atlas.2023-01-01+json

Cuerpo Requerido

Organización que desea crear.

  • clave API Objeto

    Cuenta de servicio de la 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. Tenga en cuenta que no se pueden especificar claves de API en la misma solicitud.

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

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

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

    • papeles array[string] Requerido

      Lista de roles a los que se otorga esta clave API. Si proporciona esta lista, indique al menos un rol y asegúrese de que cada uno corresponda 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.

  • ID de configuración de la federación string

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

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

  • Nombre string Requerido

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

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

  • ID de propietario de la organización string

    Cadena hexadecimal única 24que identifica al usuario de MongoDB Cloud al que desea asignar el rol de Propietario de la Organización. Este usuario debe ser miembro de la misma organización que la clave API que realiza la llamada. Si proporciona federationSettingsId, este usuario debe tener el rol de Propietario de la Organización en una organización de la federación especificada. Este parámetro solo es necesario al autenticarse 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 la 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. Tenga en cuenta que no se pueden especificar claves de API en la misma solicitud.

    Ocultar atributos de serviceAccount Mostrar atributos de 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 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}\-_.,' ]*$.

    • papeles 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 tiempo de expiración del nuevo secreto de la Cuenta de Servicio, expresado en horas. Los tiempos de expiración mínimos y máximos permitidos están sujetos a cambios y se controlan en 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 predeterminado es false.

Respuestas

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

    Creado.

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

      Detalles de las claves API programáticas.

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

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

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

      • ID. string

        Cadena de dígitos hexadecimales 24única que identifica la clave API de esta 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

        Valor de clave API pública establecido para la clave API de la organización especificada.

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

      • papeles matriz[objeto]

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

        Roles de usuario de MongoDB Cloud y la organización o proyecto correspondiente al que corresponde cada rol. Cada rol puede aplicarse a una organización o a un proyecto, pero no a ambos.

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

          Cadena única de dígitos hexadecimales 24que identifica el proyecto al que pertenece este rol. Puede 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})$.

        • nombreDeRol string

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

          Roles de usuario de MongoDB Cloud
    • ID de configuración de la federación 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})$.

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

      • está eliminado booleano

        Bandera que indica si esta organización ha sido eliminada.

      • Nombre string Requerido

        Etiqueta legible por humanos que identifica a 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 predeterminado 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 de 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}$.

      • creadoEn cadena(fecha-hora)

        Fecha de creación de 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 para humanos para la cuenta de servicio.

      • papeles 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 matriz[objeto]

        Lista de secretos asociados con la cuenta de servicio especificada.

        Ocultar atributos secretos Mostrar atributos secretos Objeto
        • creadoEn cadena(fecha-hora) Requerido

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

        • expira en cadena(fecha-hora) 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 cadena(fecha-hora)

          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 de la cuenta de servicio. Se devolverá solo la primera vez tras 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 predeterminado es false.

  • 400 aplicación/json

    Solicitud incorrecta.

    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.

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

  • 409 aplicación/json

    Conflicto.

    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/orgs
atlas api organizations createOrg --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20241023001/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.CreateOrgApiParams{}
	sdkResp, httpResp, err := client.OrganizationsApi.
		CreateOrgWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-10-23+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2024-10-23+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \
  -d '{ <Payload> }'
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"
}