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

Retornar os metadados de um provedor de identidade

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 o conteúdo do arquivo HTML de metadados SAML para um provedor de identidade na federação especificada.

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}/metadata.xml

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:

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

Tipo de arquivo
Descrição

XML

Metadados para o IdP.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/xml" \
     --header "Content-Type: application/xml" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders/{IDP-ID}/metadata.xml?pretty=true"

Exemplo de resposta

<?xml version="1.0" encoding="UTF-8"?>
<md:EntityDescriptor entityID="https://www.example.com/saml2/service-provider/sptikhtmphyefhvhjmkt" xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata"><md:SPSSODescriptor AuthnRequestsSigned="true" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><md:KeyDescriptor use="encryption"><ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><ds:X509Data><ds:X509Certificate>MIIDpjCCAo6gAwIBAgIGAWqTiVlwMA0GCSqGSIb3DQEBCwUAMIGTMQswCQYDVQQGEwJVUzETMBEG
A1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU
MBIGA1UECwwLU1NPUHJvdmlkZXIxFDASBgNVBAMMC21vbmdvZGItZGV2MRwwGgYJKoZIhvcNAQkB
Fg1pbmZvQG9rdGEuY29tMB4XDTE5MDUwNzE4MjIzM1oXDTI5MDUwNzE4MjMzM1owgZMxCzAJBgNV
BAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRYwFAYDVQQHDA1TYW4gRnJhbmNpc2NvMQ0wCwYD
VQQKDARPa3RhMRQwEgYDVQQLDAtTU09Qcm92aWRlcjEUMBIGA1UEAwwLbW9uZ29kYi1kZXYxHDAa
BgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
AQCXHOJx/t+zFgbJzloBRpGhMFxccmvMShn2OQHinrW/s7J49YGbkj0NBWpW+Y6yTZfzGm04mYe+
/1+m7+ERJpypvlF+tkNcevMmYtxTPjYvGk+GslkjdfDJFSygbtiQkLCQTbpPnGTtVvx+YSg83Rq0
a7QPQ0QeU7utE2NiTOGakIzTLd6Okb2VjBb/cv92P1fcrrY7aDbb27V2+ZBsdv8fg55xrwlMm2uv
m32ZSRWfWwYgOoUtYZxEQZoOv45MPKf0O5Ok7ICyNZAd5+zI+gS+7keKAE6mF9ux7MfokashORgf
UN2K77/xYk/1y4XSlKF1vb6+yfZr9MTkyrSCaS/tAgMBAAEwDQYJKoZIhvcNAQELBQADggEBAH+k
iR2cvXUlxOLG6gpMCuZlDdvkayBBwRNprawhEr2LLI8yGV3hRsWxsi2GoXXOCHZ62/rsn3Lg8mvQ
YAW3knId2ZsEh6mWlUljIjAtUZ5s6067KQV4u/70sO3wBQ0kcs/WnJPfz3Obb7uQ8cv0aa68IJrb
u8w5NqwWqA3FP1iuG3mfHNh6GI7DhzaVnzm9F5m7pL6hohKHMxF7n/dtuRMPTpc+UvpbnNAz/0kS
2d9fEHuMo4DXuzFZMy2ZKyFNnsVAwasAN3vdWY2S9ysGoUmCr98dS+nh4mMPSUHoPWj2myP53E08
+ZRsuZ13zI2C25+U4rgerB8XsxU7OER2CEk=</ds:X509Certificate></ds:X509Data></ds:KeyInfo><md:EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#aes128-cbc"/><md:EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#aes192-cbc"/><md:EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#aes256-cbc"/><md:EncryptionMethod Algorithm="http://www.w3.org/2009/xmlenc11#aes128-gcm"/><md:EncryptionMethod Algorithm="http://www.w3.org/2009/xmlenc11#aes256-gcm"/><md:EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#tripledes-cbc"/></md:KeyDescriptor><md:KeyDescriptor use="signing"><ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><ds:X509Data><ds:X509Certificate>MIIDpjCCAo6gAwIBAgIGAWqTiVlwMA0GCSqGSIb3DQEBCwUAMIGTMQswCQYDVQQGEwJVUzETMBEG
A1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU
MBIGA1UECwwLU1NPUHJvdmlkZXIxFDASBgNVBAMMC21vbmdvZGItZGV2MRwwGgYJKoZIhvcNAQkB
Fg1pbmZvQG9rdGEuY29tMB4XFKDLJFHwNzE4MjIzM1oXDTI5MDUwNzE4MjMzM1owgZMxCzAJBgNV
BAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRYwFAYDVQQHDA1TYW4gRnJhbmNpc2NvMQ0wCwYD
VQQKDARPa3RhMRQwEgYDVQQLDAtTU09Qcm92aWRlcjEUMBIGA1UEAwwLbW9uZ29kYi1kZXYxHDAa
BgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
AQCXHOJx/t+zFgbJzloBRpGhMFxccmvMShn2OQHinrW/s7J49YGbkj0NBWpW+Y6yTZfzGm04mYe+
/1+m7+ERJpypvlF+tkNcevMmYtxTPjYvGk+GQmZSLKJDJAygbtiQkLCQTbpPnGTtVvx+YSg83Rq0
a7QPQ0QeU7utE2NiTOGakIzTLd6Okb2VjBb/cv92P1fcrrY7aDbb27V2+ZBsdv8fg55xrwlMm2uv
m32ZSRWfWwYgOoUtYZxEQZoOv45MPKf0O5Ok7ICyNZAd5+zI+gS+7keKAE6mF9ux7MfokashORgf
UN2K77/xYk/1y4XSlKF1vb6+yfZr9MTkyrSCaS/tAgMBAAEwDQYJKoZIhvcNAQELBQADggEBAH+k
iR2cvXUlxOLG6gpMCuZlDdvkayBBwRNprawhEr2LLI8yGV3hRsWxsi2GoXXOCHZ62/rsn3Lg8mvQ
YAW3knId2ZsEh6mWlUljIjAtUZ5s6067KQV4u/70sO3wBQ0kcs/WnJPfz3Obb7uQ8cv0aa68IJrb
u8w5NqwWqA3FP1iuG3mfHNh6GI7DhzaVnzm9F5m7pL6hohKHMxF7n/dtuRMPTpc+UvpbnNAz/0kS
2d9fEHuMo4DXuzFZMy2ZKyFNnsVAwasAN3vdWY2S9ysGoUmCr98dS+nh4mMPSUHoPWj2myP53E08
l:lang="en">http://www.mongodb.com/</md:OrganizationURL></md:Organization>

Voltar

Retornar fornecedor de identidade

Próximo

Excluir mapeamento de função