Remover um utilizador de banco de dados de um projeto
Remove um usuário do banco de dados do 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, a função de proprietário do processamento de fluxo do projeto ou a função de administrador de 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
atlas api databaseUsers deleteGroupDatabaseUser --help
import (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20231001001/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.DeleteGroupDatabaseUserApiParams{}
httpResp, err := client.DatabaseUsersApi.
DeleteGroupDatabaseUserWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-10-01+json" \
-X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-10-01+json" \
-X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}"
{
"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"
}