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

Retornar todos os provedores de identidade conectados

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
  • results documento incorporado
  • Exemplo de solicitaçãoSAML
  • Exemplo de resposta SAML
  • Exemplo de solicitação de OIDC
  • Exemplo de resposta do OIDC

O recurso federationSettings permite a você retornar todos os fornecedores 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/

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 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 uma lista de resultados, o objeto results é um envelope. O Cloud Manager adiciona o campo status ao corpo da resposta.

false

protocolo

string

Opcional

O(s) protocolo(s) dos IdPs de destino. Os valores possíveis são:

  • SAML

  • OIDC

Se isso não for especificado, esse ponto retornará apenas SAML IdPs.

SAML

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 result , uma array de objetos link e uma contagem do número total de objetos result recuperados.

Nome
Tipo
Descrição

results

array

A array inclui um objeto para cada item detalhado na seção results Documento incorporado.

links

array

A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web.

totalCount

número

Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado.

results documento incorporado

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

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.

Nome
Tipo
Descrição

Certificados

array

Lista que contém a data de início e a data de expiração do certificado de chave pública codificado em PEMdo provedor de identidade.

Nome do Arquivo

string

Etiqueta que identifica o arquivo que contém o 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:

  • HTTP POST

  • HTTP REDIRECT

responseSignatureAlgorithm

string

Algoritmo usado para criptografar a assinatura do IdP . Cloud Manager aceita os seguintes valores de algoritmo de assinatura:

  • SHA-1

  • SHA-256

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çãoSAML

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"

Exemplo de resposta SAML

{
 "links": [
     {
         "links" : [ {
 "href" : "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders?pretty=true&pageNum=1&itemsPerPage=100",
         "rel": "self"
     }
 ],
 "results": [
     {
         "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"
     } ],
 "totalCount": 1
}

Exemplo de solicitação deOIDC

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?protocol=OIDC"

Exemplo de resposta do OIDC

{
 "links": [
     {
         "links" : [ {
 "href" : "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders?pretty=true&pageNum=1&itemsPerPage=100",
         "rel": "self"
     }
 ],
 "results": [
     {
         "associatedDomains": [],
         "associatedOrgs": [],
         "audienceClaim": [
             "audience"
         ],
         "clientId": "clientId",
         "description": "OIDC IdP response example",
         "displayName": "OIDC IdP",
         "groupsClaim": "groups",
         "id": "32b6e34b3d91647abb20e7b8",
         "issuerUri": "issuer.com",
         "oktaIdpId": null,
         "protocol": "OIDC",
         "requestedScopes": [
             "scopes"
         ],
         "userClaim": "sub"
     }
 ],
 "totalCount": 1
}

Voltar

Retornar mapeamento de função

Próximo

Retornar fornecedor de identidade