Atualizar um provedor de identidade
Obsoleto(a)
Atualiza 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.
Aviso: alterar tipos de autorização e/ou atualizar declarações de autorização pode impedir que usuários e/ou grupos atuais acessem o banco de dados.
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 única que identifica o provedor de identidade a ser conectado. Se estiver usando uma versão da API anterior a 11-15-2023, use o ID legado 20-hexadecimal. Esse ID pode ser encontrado na aba 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. Para todas as outras versões, use o ID de 24 dígitos hexadecimais.
parâmetros de query
-
Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON
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 consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.O valor padrão é
false.
corpo, corpo
Obrigatório
O fornecedor de identidade que você deseja atualizar.
-
Lista que contém os domínios associados ao provedor de identidade.
-
A descrição do provedor de identidade.
-
Rótulo legível por humanos que identifica o provedor de identidade.
O comprimento mínimo é
1, o comprimento máximo é50. -
enumeração de string que indica o tipo do provedor de identidade. O padrão é WORKFORCE.
Os valores são
WORKFORCEouWORKLOAD. -
String exclusiva que identifica o emissor da SAML Assertion ou metadados OIDC/URL do documento de descoberta.
-
Informações do arquivo PEM para os certificados vigentes do provedor de identidade.
-
Enumeração de string que indica o protocolo do provedor de identidade. SAML ou OIDC.
Os valores são
SAMLouOIDC. -
Vinculação de método HTTP de Protocolo de Solicitação de Autenticação SAML (POST ou REDIRECT) que a autenticação federada usa para enviar a solicitação de autenticação.
Os valores são
HTTP-POSTouHTTP-REDIRECT. -
Algoritmo de assinatura que a autenticação federada usa para criptografar a assinatura do provedor de identidade.
Os valores são
SHA-1ouSHA-256. -
URL de SSO personalizada para o provedor de identidade.
-
Sinalizador que indica se o fornecedor de identidade tem a depuração de SSO habilitada.
-
URL que aponta para o receptor da solicitação de autenticação SAML.
-
Enum de string que indica se o provedor de identidade está ativo.
Os valores são
ACTIVEouINACTIVE.
atlas api federatedAuthentication updateFederationSettingIdentityProvider --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230201001/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.UpdateFederationSettingIdentityProviderApiParams{}
sdkResp, httpResp, err := client.FederatedAuthenticationApi.
UpdateFederationSettingIdentityProviderWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-02-01+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-02-01+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \
-d '{ <Payload> }'{
"associatedDomains": [
"string"
],
"description": "string",
"displayName": "string",
"idpType": "WORKFORCE",
"issuerUri": "urn:idp:default",
"pemFileInfo": {
"certificates": [
{
"content": "string",
"notAfter": "2025-05-04T09:42:00Z",
"notBefore": "2025-05-04T09:42:00Z"
}
],
"fileName": "string"
},
"protocol": "SAML",
"requestBinding": "HTTP-POST",
"responseSignatureAlgorithm": "SHA-1",
"slug": "string",
"ssoDebugEnabled": true,
"ssoUrl": "https://example.com",
"status": "ACTIVE"
}{
"acsUrl": "string",
"associatedDomains": [
"string"
],
"associatedOrgs": [
{
"dataAccessIdentityProviderIds": [
"string"
],
"domainAllowList": [
"string"
],
"domainRestrictionEnabled": true,
"identityProviderId": "string",
"orgId": "32b6e34b3d91647abb20e7b8",
"postAuthRoleGrants": [
"ORG_OWNER"
],
"roleMappings": [
{
"externalGroupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"roleAssignments": [
{
"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"role": "ORG_OWNER"
}
]
}
],
"userConflicts": [
{
"emailAddress": "hello@example.com",
"federationSettingsId": "32b6e34b3d91647abb20e7b8",
"firstName": "string",
"lastName": "string",
"userId": "32b6e34b3d91647abb20e7b8"
}
]
}
],
"audienceUri": "string",
"createdAt": "2025-05-04T09:42:00Z",
"description": "string",
"displayName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"idpType": "WORKFORCE",
"issuerUri": "string",
"oktaIdpId": "string",
"pemFileInfo": {
"certificates": [
{
"notAfter": "2025-05-04T09:42:00Z",
"notBefore": "2025-05-04T09:42:00Z"
}
],
"fileName": "string"
},
"protocol": "SAML",
"requestBinding": "HTTP-POST",
"responseSignatureAlgorithm": "SHA-1",
"slug": "string",
"ssoDebugEnabled": true,
"ssoUrl": "string",
"status": "ACTIVE",
"updatedAt": "2025-05-04T09:42:00Z"
}{
"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"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"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"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}