MOmongodb
X.509 Authentication

Create One X.509 Certificate for One Database User

Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project.

To get MongoDB Cloud to generate a managed certificate for a database user, set "x509Type" : "MANAGED" on the desired MongoDB Database User.

If you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA.

post/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

groupIdstring required
Example:32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

usernamestring required

Human-readable label that represents the MongoDB database user account for whom to create a certificate.

Query parameters

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

Request body

_idinteger

Unique 24-hexadecimal character string that identifies this certificate.

createdAtstring date-time

Date and time when MongoDB Cloud created this certificate. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

groupIdstring

Unique 24-hexadecimal character string that identifies the project.

monthsUntilExpirationinteger

Number of months that the certificate remains valid until it expires.

notAfterstring date-time

Date and time when this certificate expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

subjectstring

Subject Alternative Name associated with this certificate. This parameter expresses its value as a distinguished name as defined in RFC 2253.

Example request

{
  "groupId": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "subject": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com"
}

Response

This endpoint returns a PEM file with the certificate and private key.

Changes

No recorded changes to this operation across all 1 revision of this API.