Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos
/
Organizações e equipes
/
Organizações

Criar uma organização

Nesta página

  • Funções obrigatórias
  • Solicitar
  • Parâmetros da solicitação
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Parâmetros de resposta
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Funções obrigatórias

Sua chave de API deve ter a função Global Owner para chamar esse recurso com êxito.

Observação

Se você usar uma chave de API programática global para criar uma organização, o Ops Manager criará a organização sem um Organization Owner. Para adicionar um Organization Owner, consulte Acesso ao Ops Manager.

Solicitar

POST /orgs

Parâmetros da solicitação

Parâmetros do caminho da solicitação

Este endpoint não usa parâmetros de caminho de solicitação HTTP.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
necessidade
Descrição
Default

pageNum

número

Opcional

Um inteiro baseado que retorna uma subseção de resultados.

1

itemsPerPage

número

Opcional

Número de itens a serem devolvidos por página, até um máximo de 500.

100

pretty

booleano

Opcional

Sinalizador que indica se o corpo da resposta deve estar em um prettyprint formato.

false

envelope

booleano

Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes do API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure envelope : true na consulta.

Para endpoints que retornam uma lista de resultados, o objeto results é um envelope. O Ops Manager adiciona o campo status ao corpo da resposta.

false

backupJobsEnabledOnly

booleano

Opcional

Sinalizador que indica se os daemon não habilitados para reconhecimento de data center devem ser excluídos da resposta. Defina isso como false para incluir configurações de daemon com o sinalizador backupJobsEnabled definido como false.

true

Parâmetros do corpo da solicitação

Nome
Tipo
necessidade
Descrição

ldapGroupMappings

array

Opcional

Requer integração LDAP para o Ops Manager.

Array de documentos que especificam o mapeamento entre as MongoDB Ops Manager funções da organização do e os LDAP grupos .

Se especificar ldapGroupMappings, o mapeamento para a role ORG_OWNER será necessário.

ldapGroupMappings
.roleName

string

Opcional

Role da organização do Ops Manager para mapear. Pode especificar a partir da seguinte lista:

  • ORG_READ_ONLY

  • ORG_MEMBER

  • ORG_OWNER

Não é possível especificar uma role global, uma role de projeto ou uma role de administrador de faturamento da organização.

ldapGroupMappings
.ldapGroups

array

Opcional

Grupo(s) LDAP que mapeiam para associar ao roleName.

name

string

Obrigatório

Nome da organização que você deseja criar.

Parâmetros de resposta

Nome
Tipo
Descrição

id

string

Identificador único da organização.

name

string

Nome da organização.

Exemplo de solicitação

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --header 'Content-Type: application/json' \
 --include \
 --request POST "https://{opsManagerHost}:{port}/api/public/v1.0/orgs" \
 --data
   '{ "name" : "myNewOrganization" }'

Exemplo de resposta

Cabeçalho de resposta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Corpo de resposta

{
  "id" : "{ORG-ID}",
  "name" : "myNewOrganization"
}

Voltar

Obter todos os usuários

Próximo

Renomear organização