Retornar a configuração da federação para uma organização
Nesta página
- 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 a configuração de autenticação federada para uma organização.
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 /orgs/{ORG-ID}/federationSettings
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
|---|---|---|
| string | String única de 24 dígitos hexadecimais que identifica a organização. |
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. |
| ||||||
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:
|
|
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 |
|---|---|---|
| array de strings | Lista que contém os domínios associados ao provedor de identidade da organização. |
| booleano | Sinalizador que indica se esta organização tem mapeamentos de role configurados. Para saber mais sobre mapeamento de role, consulte Managed roles do Cloud Manager de mapeamento para grupos IdP. |
| string | String exclusiva de 24 dígitos hexadecimais que identifica esta federação. |
| string | String exclusiva de 20 dígitos hexadecimais que identifica o provedor de identidade conectado a esta organização. |
| string | O valor que indica se o provedor de identidade está ativo. O Cloud Manager retorna |
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/federationSettings"
Exemplo de resposta
{ "federatedDomains": [ "example.com" ], "hasRoleMappings": false, "id": "5e8cc670a16506712e0b1e95", "identityProviderId": "0oa8i0grsgbwDiIyw453", "identityProviderStatus": "INACTIVE" }