Docs Menu
Docs Home
/ /

atlas api x509Authentication

Returns, edits, and removes user-managed X.509 configurations.

The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users.

Name
Type
Required
Description

-h, --help

false

help for x509Authentication

Name
Type
Required
Description

-P, --profile

string

false

Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

  • atlas api x509Authentication createDatabaseUserCert - Generates one X.509 certificate for the specified MongoDB user.

  • atlas api x509Authentication disableSecurityCustomerX509 - Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509.

  • atlas api x509Authentication listDatabaseUserCerts - Returns all unexpired X.509 certificates for the specified MongoDB user.

Back

updateThirdPartyIntegration

On this page