Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/
API
/
Recursos
/
Autenticação federada

Retornar uma organização conectada

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
  • Exemplo de solicitação
  • Exemplo de resposta

O recurso federationSettings permite a você retornar uma organização conectada 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 o role Organization Owner para chamar esse endpoint.

Resource

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

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.

ORG-ID

string

String exclusiva de 24 dígitos hexadecimais que identifica a organização conectada.

Solicitar parâmetros de query

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

Nome
Tipo
necessidade
Descrição
Default

pretty

booleano

Opcional

Sinalizador indicando 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 da API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina 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

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

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/{ORG-ID}"

Exemplo de resposta

{
 "domainAllowList": [],
 "domainRestrictionEnabled": false,
 "identityProviderId": null,
 "orgId": "5f86fb11e0079069c9ec3132",
 "postAuthRoleGrants": [],
 "roleMappings": [],
 "userConflicts": null
}

Voltar

Retornar todas as organizações

Próximo

Atualizar organização