/ /

Organizações e equipes

Organizações

Página inicial do Docs

Organizações e equipes

Organizações

Obter uma organização

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

Resource

GET /orgs/{ORG-ID}

Parâmetros do caminho da solicitação

Elemento do caminho	Tipo	Descrição
ORG-ID	string	(Obrigatório.) O identificador exclusivo daorganização cujas informações você deseja recuperar.

Solicitar parâmetros de query

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

Nome

Tipo

Descrição

Default

pretty

booleano

Sinalizador que indica se o corpo da resposta deve estar em um formato pretty-print.

false

envelope

booleano

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

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

Para endpoints que retornam um resultado, o corpo da resposta inclui:

Nome	Descrição
`status`	Código de resposta HTTP
`content`	Corpo de resposta esperado

false

includeDeletedOrgs

booleano

Sinalizador que indica se o corpo da resposta contém organizações excluídas.

O Ops Manager honra o valor deste parâmetro somente se o usuário que faz a solicitação tiver uma role global.

Se configurado para true ou omitido, os usuários atribuídos a uma função global recebem projetos excluídos na resposta. Se configurado para false ou se o usuário não tiver uma função de proprietário global, a resposta não conterá organizações excluídas.

true

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Resposta

Nome	Tipo	Descrição
id	string	Identificador único da organização.
isDeleted	booleano	Indica se a organização foi excluída.
name	string	Nome da organização.
links	array de objetos	Um ou mais links para sub-recursos ou recursos relacionados. Todas as arrays `links` nas respostas incluem pelo menos um link chamado `self`. Os relacionamentos entre URLs são explicados na Especificação de links da web.

Exemplo de solicitação

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/"

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}",
   "isDeleted": false,
   "links": [{
   }],
   "name" : "Customer Application Support"
}

Voltar

Obter todas as organizações

Obter todos os projetos