Atualizar uma configuração de organização em uma federação
Atualiza uma configuração da organização conectada a partir da federação especificada. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função proprietário da organização.
Aviso: se a configuração da organização não tiver um fornecedor de identidade associado, você não poderá usar esse recurso para atualizar mapeamentos de role ou publicar concessões de role de autorização.
Observação: o campo domainRestrictionEnabled fica definido como "false" por padrão se não for fornecido na solicitação.
Observação: se o campo identityProviderId não for fornecido, você desconectará a organização e o provedor de identidade.
Aviso: os fornecedores de identidade de acesso a dados conectados no momento que não estão no campo dataAccessIdentityProviderIDs serão desconectados.
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 exclusiva de 24 dígitos hexadecimais que identifica a configuração da organização conectada que será atualizada.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$.
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
A configuração da organização conectada que você deseja atualizar.
-
A collection de IDs únicos que representam os fornecedores de identidade que podem ser usados para acesso a dados nessa organização.
-
Domínios aprovados que restringem os usuários que podem ingressar na organização com base em seus endereços de e-mail.
-
O valor que indica se a restrição de domínio está habilitada para esta organização conectada.
-
String 20-hexadecimal legada que identifica o provedor de identidade de acesso à interface do usuário ao qual essa configuração da organização conectada está associada. Esse ID pode ser encontrado na guia Console de gerenciamento federado > aba Provedor de identidade, clicando no ícone de informações na linha IdP ID de um provedor de identidade configurado.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{20})$. -
Funções do Atlas que são concedidas a um usuário nessa organização após a autenticação. As funções são um rótulo legível por humanos que identifica a coleção de privilégios que o MongoDB Cloud concede a um usuário específico do MongoDB Cloud. Essas funções só podem ser funções específicas da organização.
Os valores são
ORG_OWNER,ORG_MEMBER,ORG_GROUP_CREATOR,ORG_BILLING_ADMIN,ORG_BILLING_READ_ONLY,ORG_STREAM_PROCESSING_ADMINouORG_READ_ONLY. -
Mapeamentos de role configurados nesta organização.
Configurações de mapeamento que vinculam um IdP e a nuvem MongoDB .
-
Lista que contém os usuários com um endereço de e-mail que não corresponde a nenhum domínio na lista de permissões.
Usuário do MongoDB Cloud vinculado a esta autenticação federada.
atlas api federatedAuthentication updateConnectedOrgConfig --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.UpdateFederationSettingConnectedOrgConfigApiParams{}
sdkResp, httpResp, err := client.FederatedAuthenticationApi.
UpdateFederationSettingConnectedOrgConfigWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \
-d '{ <Payload> }'{
"dataAccessIdentityProviderIds": [
"string"
],
"domainAllowList": [
"string"
],
"domainRestrictionEnabled": true,
"identityProviderId": "string",
"postAuthRoleGrants": [
"ORG_OWNER"
],
"roleMappings": [
{
"externalGroupName": "string",
"roleAssignments": [
{
"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"role": "ORG_OWNER"
}
]
}
],
"userConflicts": [
{
"emailAddress": "hello@example.com",
"federationSettingsId": "32b6e34b3d91647abb20e7b8",
"firstName": "string",
"lastName": "string"
}
]
}{
"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"
}
]
}{
"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"
}