Criar uma organização
Cria uma organização no MongoDB Cloud e a vincula à organização da conta de serviço ou da chave de API solicitante. Para usar este recurso, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário da organização. A organização da conta de serviço ou da chave de API solicitante deve ser uma organização pagante. Para saber mais, consulte Configurar uma organização de pagamento na documentação do MongoDB Atlas.
parâmetros de query
-
Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON
envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.O valor padrão é
false. -
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é
false.Prettyprint
corpo, corpo
Obrigatório
Organização que você deseja criar.
-
Conta de serviço da organização que o Atlas cria para esta organização. Se omitido, o Atlas não cria uma Conta de Serviço da organização para esta organização. Se especificado, este objeto exige todos os parâmetros do corpo. Observe que as chaves API não podem ser especificadas na mesma solicitação.
-
String única de 24 dígitos hexadecimais que identifica a federação à qual vincular a organização recém-criada. Se especificado, o proprietário da organização proposto da nova organização deve ter a role de proprietário da organização em uma organização associada à federação.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$. -
Etiqueta legível para humanos que identifica a organização.
O formato deve corresponder ao seguinte padrão:
^[\p{L}\p{N}\-_.(),:&@+']{1,64}$. -
String exclusiva 24 dígitos hexadecimais que identifica o usuário do MongoDB Cloud ao qual você deseja atribuir a função "Proprietário da organização". Esse usuário deve ser um membro da mesma organização que a chave de API de chamada. Se você fornecer
federationSettingsId, esse usuário deverá ter a função "Proprietário da organização" em uma organização na federação especificada. Esse parâmetro é necessário somente quando você se autentica com chaves de API programáticas.O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$. -
Conta de serviço da organização que o Atlas cria para esta organização. Se omitido, o Atlas não cria uma Conta de Serviço da organização para esta organização. Se especificado, este objeto exige todos os parâmetros do corpo. Observe que as chaves API não podem ser especificadas na mesma solicitação.
-
Desabilita a criação automática de alerta . Quando definido como verdadeiro, nenhum alerta no nível da organização será criado automaticamente.
O valor padrão é
false.
atlas api organizations createOrg --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20240530001/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-05-30+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-05-30+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \
-d '{ <Payload> }'{
"apiKey": {
"desc": "string",
"roles": [
"ORG_OWNER"
]
},
"federationSettingsId": "32b6e34b3d91647abb20e7b8",
"name": "string",
"orgOwnerId": "32b6e34b3d91647abb20e7b8",
"serviceAccount": {
"description": "string",
"name": "string",
"roles": [
"ORG_MEMBER"
],
"secretExpiresAfterHours": 8
},
"skipDefaultAlertsSettings": false
}{
"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": "ORG_MEMBER"
}
]
},
"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": "2025-05-04T09:42:00Z",
"description": "string",
"name": "string",
"roles": [
"ORG_MEMBER"
],
"secrets": [
{
"createdAt": "2025-05-04T09:42:00Z",
"expiresAt": "2025-05-04T09:42:00Z",
"id": "32b6e34b3d91647abb20e7b8",
"lastUsedAt": "2025-05-04T09:42:00Z",
"maskedSecretValue": "mdb_sa_sk_...",
"secret": "mdb_sa_sk_..."
}
]
},
"skipDefaultAlertsSettings": false
}{
"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"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"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"
}{
"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"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}