Retornar todas as organizações conectadas

Nesta página

Funções obrigatórias

Resource
Parâmetros do caminho da solicitação
Solicitar parâmetros de query
Parâmetros do corpo da solicitação
Resposta
documento de resposta
documento incorporado de resultados
Exemplo de solicitação
Exemplo de resposta

O Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.

A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.: O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .

O recurso federationSettings permite a você retornar todas as organizações conectadas para uma configuração de autenticação federada.

URL base: https://cloud.mongodb.com/api/public/v1.0

Funções obrigatórias

Você deve ter a função Organization Owner para pelo menos uma organização conectada na configuração da federação para chamar esse endpoint.

Resource

GET /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/

Parâmetros do caminho da solicitação

Nome	Tipo	Descrição
`FEDERATION-SETTINGS-ID`	string	String exclusiva de 24 dígitos hexadecimais que identifica a configuração da autenticação federada.

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 `content` é um envelope. O Cloud 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

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

Resposta

documento de resposta

O documento JSON de resposta inclui uma array de objetos de resultado , uma array de objetos de link e uma contagem do número total de objetos de resultado recuperados.

Nome	Tipo	Descrição
Resultados	Array de objetos	Um objeto para cada item detalhado na seção Documento incorporado de resultados.
links	Array de objetos	Um ou mais links para sub-recursos e/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.
contagem total	inteiro	Contagem do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array de resultados se todo o conjunto de resultados for paginado.

documento incorporado de resultados

Cada documento no array result contém a configuração de autenticação federada para cada organização conectada.

Nome	Tipo	Descrição
`domainAllowList`	array	Lista que contém os domínios aprovados a partir da qual os usuários da organização podem se conectar.
`domainRestrictionEnabled`	booleano	Sinalizador que indica se a restrição de domínio está habilitada para a organização conectada. `userConflicts` retorna `null` quando `"domainRestrictionEnabled": false`.
`identityProviderId`	string	String exclusiva de 20 dígitos hexadecimais que identifica o provedor de identidade associado à organização conectada.
`orgId`	string	String exclusiva de 24 dígitos hexadecimais que identifica a organização conectada.
`postAuthRoleGrants`	array	Lista que contém as roles padrão concedidas aos usuários que se autenticam por meio do IdP em uma organização conectada.
`roleMappings`	array	Lista que contém os mapeamentos de role configurados nesta organização.
`userConflicts`	array	Lista que contém os nomes de usuário que não correspondem a nenhum domínio na lista de permissões. `userConflicts` retorna `null` quando `"domainRestrictionEnabled": false`.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs"

Exemplo de resposta

{
 "links": [
     {
         "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs?pageNum=1&itemsPerPage=100",
         "rel": "self"
     }
 ],
 "results": [
     {
         "domainAllowList": [],
         "domainRestrictionEnabled": false,
         "identityProviderId": null,
         "orgId": "5f86fb11e0079069c9ec3132",
         "postAuthRoleGrants": [],
         "roleMappings": [],
         "userConflicts": null
     }
 ],
 "totalCount": 1
}

Voltar

Retornar configuração

Organização de devolução