Retornar um fornecedor de identidade conectado
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 autenticação OAuth 2.0 , crie umaconta de serviço para usar em suas solicitações para a API pública do Cloud Manager .
O recurso federationSettings permite a você retornar um fornecedor de identidade para uma configuração de autenticação federada.
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}/identityProviders/{IDP-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. |
IDP-ID | string | String única de 24 dígitos hexadecimais que identifica o IdP. |
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 de 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:
| 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 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
acsUrl | string | URL do serviço do consumidor de declaração para a qual o IdP envia a resposta SAML. | |||||||||
associatedDomains | array | Lista que contém os domínios configurados a partir dos quais os usuários podem se conectar para esse IdP. | |||||||||
associatedOrgs | array | Lista que contém as organizações das quais os usuários podem se conectar para este IdP. | |||||||||
audienceUri | string | Identificador para o público pretendido da Asserção SAML. | |||||||||
displayName | string | Etiqueta legível para humanos que identifica o IdP. | |||||||||
issuerUri | string | Identificador para o emissor da Asserção SAML. | |||||||||
oktaIdpId | string | String exclusiva de 20 dígitos hexadecimais que identifica o IdP. | |||||||||
pemFileInfo | array | Lista que contém as informações do arquivo, incluindo: data de início e data de expiração do certificado de chave pública codificado em PEMdo provedor de identidade.
| |||||||||
requestBinding | string | Vinculação do protocolo de solicitação de autenticação SAML usada para enviar o AuthNRequest. O Cloud Manager suporta os seguintes valores de associação:
| |||||||||
responseSignatureAlgorithm | string | Algoritmo usado para criptografar a assinatura do IdP . Cloud Manager aceita os seguintes valores de algoritmo de assinatura:
| |||||||||
ssoDebugEnabled | booleano | Sinalizador que indica se o IdP tem a depuração de SSO habilitada. | |||||||||
ssoUrl | string | URL do receptor do AuthNRequest SAML. | |||||||||
status | string | Etiqueta que indica se o provedor de identidade está ativo. O IdP é Inactive até que você mapeie pelo menos um domínio para o IdP. |
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/federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders/{IDP-ID}"
Exemplo de resposta
{ "acsUrl" : "https://example.mongodb.com/sso/saml2/12345678901234567890", "associatedDomains" : [ ], "associatedOrgs" : [ ], "audienceUri" : "https://www.example.com/saml2/service-provider/abcdefghij1234567890", "displayName" : "Test", "issuerUri" : "urn:123456789000.us.provider.com", "oktaIdpId" : "1234567890abcdefghij", "pemFileInfo" : { "certificates" : [ { "notAfter" : "2035-09-29T15:03:55Z", "notBefore" : "2022-01-20T15:03:55Z" } ], "fileName" : "file.pem" }, "requestBinding" : "HTTP-POST", "responseSignatureAlgorithm" : "SHA-256", "ssoDebugEnabled" : true, "ssoUrl" : "https://123456789000.us.provider.com/samlp/12345678901234567890123456789012", "status" : "INACTIVE" }