Retornar metadados de um provedor de identidade
Retorna os metadados de um provedor de identidade na federação especificada. Para usar esse recurso, a conta de serviço ou chave de API solicitante deve ter a função de proprietário da organização em uma das organizações conectadas.
parâmetros de caminho
-
String exclusiva de 24 dígitos hexadecimais que identifica sua federação.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$. -
String legada com 20 dígitos hexadecimais que identifica o provedor de identidade. Essa ID pode ser encontrada na guia Console de Gerenciamento de Federação > Provedores de Identidade, clicando no ícone de informações na linha ID do IdP de um provedor de identidade configurado.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{20})$.
GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml
Atlas CLI
atlas api federatedAuthentication getIdentityProviderMetadata --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230101001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.GetFederationSettingIdentityProviderMetadataApiParams{}
sdkResp, httpResp, err := client.FederatedAuthenticationApi.
GetFederationSettingIdentityProviderMetadataWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true"
Exemplos de resposta (200)
string
Exemplos de resposta (400)
{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}
Exemplos de resposta (401)
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
Exemplos de resposta (403)
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Exemplos de resposta (404)
{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}
Exemplos de resposta (500)
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}