Atualizar um utilizador de banco de dados em um projeto
Atualiza um usuário de banco de dados que pertence ao projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário do projeto, de administrador de gráficos do projeto, de proprietário do processamento de fluxo do projeto ou de administrador do acesso ao banco de dados do projeto.
parâmetros de caminho
-
Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.
AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$. -
O banco de dados no qual o utilizador de banco de dados se autentica. Os usuários do banco de dados devem fornecer um nome de usuário e um banco de dados de autenticação para fazer login no MongoDB. Se o usuário se autenticar com Amazon Web Services IAM, x.509, LDAP ou OIDC Workload, esse valor deverá ser
$external. Se o usuário se autenticar com SCRAM-SHA ou OIDC Workforce, esse valor deverá seradmin. -
Rótulo legível por humanos que representa o usuário que se autentica no MongoDB. O formato desse rótulo depende do método de autenticação:
Método de autenticação Parâmetro necessário Valor do parâmetro formato de nome de usuário AWS IAM awsIAMType FUNÇÃO ARN AWS IAM awsIAMType USUÁRIO ARN x.509 x509Type CLIENTE Nome DistintoRFC 2253 x.509 x509Type GERENCIADO Nome DistintoRFC 2253 LDAP ldapAuthType USUÁRIO Nome DistintoRFC 2253 LDAP ldapAuthType GRUPO Nome DistintoRFC 2253 OIDC Workforce oidcAuthType IDP_GROUP ID OIDC do Atlas (encontrado nas configurações de federação), seguido por uma "/", seguido pelo nome do grupo IdP Carga de trabalho do OIDC oidcAuthType USUÁRIO O ID do provedor de identidade (IdP) do Atlas OIDC (encontrado nas configurações de federação), seguido por uma "/", depois pelo nome de usuário do IdP SCRAM-SHA awsIAMType, x509Type, ldapAuthType, oidcAuthType none Texto alfanumérico
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. -
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é
false.Prettyprint
corpo, corpo
Obrigatório
Atualiza um usuário de banco de dados que pertence ao projeto especificado.
-
Rótulo legível por humanos que indica se o novo usuário do banco de dados se autentica com as credenciais do Amazon Web Services (AWS) Identity and Access Management (IAM) associadas ao usuário ou à função do usuário.
Os valores são
NONE,USERouROLE. O valor padrão éNONE. -
O banco de dados no qual o utilizador de banco de dados se autentica. Os usuários do banco de dados devem fornecer um nome de usuário e um banco de dados de autenticação para fazer login no MongoDB. Se o usuário se autenticar com Amazon Web Services IAM, x.509, LDAP ou OIDC Workload, esse valor deverá ser
$external. Se o usuário se autenticar com SCRAM-SHA ou OIDC Workforce, esse valor deverá seradmin.Os valores são
adminou$external. O valor padrão éadmin. -
Data e hora em que o MongoDB Cloud exclui o usuário. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC e pode incluir a designação de zona. Você deve especificar uma data futura que caia dentro de uma semana após fazer a solicitação de Interface de Programação de Aplicativo (API).
-
Descrição deste usuário de banco de dados.
O comprimento máximo é
100. -
String única de 24 dígitos hexadecimais que identifica o projeto.
-
Lista que contém os pares de valores-chave para marcar e categorizar o usuário do banco de dados MongoDB. Os rótulos que você define não aparecem no console.
Rótulos legíveis por humanos aplicados a este componente MongoDB Cloud.
-
Parte do registro do Lightweight Directory Access Protocol (LDAP) que o banco de dados usa para autenticar esse usuário do banco de dados no host LDAP.
Os valores são
NONE,GROUPouUSER. O valor padrão éNONE. -
Rótulo legível por humanos que indica se o novo usuário de banco de dados ou grupo se autentica com a autenticação federada OIDC. Para criar um usuário de autenticação federado, especifique o valor de USER neste campo. Para criar um grupo de autenticação federado, especifique o valor de IDP_GROUP neste campo.
Os valores são
NONE,IDP_GROUPouUSER. O valor padrão éNONE. -
String alfanumérica que autentica este usuário de banco de dados no banco de dados especificado no
databaseName. Para autenticar com SCRAM-SHA, você deve especificar este parâmetro. Este parâmetro não aparece nesta resposta.O comprimento mínimo é
8.SCRAM-SHA -
Lista que fornece os pares de um papel com um banco de dados aplicável.
Faixa de recursos disponíveis para esse usuário de banco de dados.
-
Lista que contém clusters, data lakes do MongoDB Atlas e instâncias de stream do MongoDB Atlas que esse usuário de banco de dados pode acessar. Se omitido, o MongoDB Cloud concede ao usuário do banco de dados acesso a todos os clusters, todos os data lakes do MongoDB Atlas e todas as instâncias de stream do MongoDB Atlas no projeto.
Faixa de recursos disponíveis para esse usuário de banco de dados.
-
Rótulo legível por humanos que representa o usuário que se autentica no MongoDB. O formato desse rótulo depende do método de autenticação:
Método de autenticação Parâmetro necessário Valor do parâmetro formato de nome de usuário AWS IAM awsIAMType FUNÇÃO ARN AWS IAM awsIAMType USUÁRIO ARN x.509 x509Type CLIENTE Nome DistintoRFC 2253 x.509 x509Type GERENCIADO Nome DistintoRFC 2253 LDAP ldapAuthType USUÁRIO Nome DistintoRFC 2253 LDAP ldapAuthType GRUPO Nome DistintoRFC 2253 OIDC Workforce oidcAuthType IDP_GROUP ID OIDC do Atlas (encontrado nas configurações de federação), seguido por uma "/", seguido pelo nome do grupo IdP Carga de trabalho do OIDC oidcAuthType USUÁRIO O ID do provedor de identidade (IdP) do Atlas OIDC (encontrado nas configurações de federação), seguido por uma "/", depois pelo nome de usuário do IdP SCRAM-SHA awsIAMType, x509Type, ldapAuthType, oidcAuthType none Texto alfanumérico O comprimento máximo é
1024. -
Método X.509 que o MongoDB Cloud usa para autenticar o usuário de banco de dados.
- Para X.509 gerenciado pelo aplicativo, especifique
MANAGED. - Para X.509 autogerenciado, especifique
CUSTOMER.
Os usuários criados com o método
CUSTOMERexigem um Nome Comum (CN) no parâmetro username. Você deve criar usuários autenticados externamente no banco de dados do$external.Os valores são
NONE,CUSTOMERouMANAGED. O valor padrão éNONE. - Para X.509 gerenciado pelo aplicativo, especifique
atlas api databaseUsers updateGroupDatabaseUser --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20231115001/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.UpdateGroupDatabaseUserApiParams{}
sdkResp, httpResp, err := client.DatabaseUsersApi.
UpdateGroupDatabaseUserWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-11-15+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-11-15+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \
-d '{ <Payload> }'{
"awsIAMType": "NONE",
"databaseName": "admin",
"deleteAfterDate": "2025-05-04T09:42:00Z",
"description": "string",
"groupId": "string",
"labels": [
{
"key": "string",
"value": "string"
}
],
"ldapAuthType": "NONE",
"oidcAuthType": "NONE",
"password": "string",
"roles": [
{
"collectionName": "string",
"databaseName": "string",
"roleName": "atlasAdmin"
}
],
"scopes": [
{
"name": "string",
"type": "CLUSTER"
}
],
"username": "string",
"x509Type": "NONE"
}{
"awsIAMType": "NONE",
"databaseName": "admin",
"deleteAfterDate": "2025-05-04T09:42:00Z",
"description": "string",
"labels": [
{
"key": "string",
"value": "string"
}
],
"ldapAuthType": "NONE",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oidcAuthType": "NONE",
"roles": [
{
"collectionName": "string",
"databaseName": "string",
"roleName": "atlasAdmin"
}
],
"scopes": [
{
"name": "string",
"type": "CLUSTER"
}
],
"username": "string",
"x509Type": "NONE"
}{
"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": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}