Get Current X.509 Configuration¶
Get the current customer-managed X.509 configuration details for an Atlas project.
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
.
Required Roles¶
You must have the Atlas admin
role to use this endpoint.
Resource¶
X.509 configurations and LDAP configurations are managed using the same resource. Requests to the resource will return both configuration objects.
https://cloud.mongodb.com/api/atlas/v1.0
GET /groups/{GROUP-ID}/userSecurity
Request¶
Path Parameters¶
Parameter | Type | Necessity | Description |
---|---|---|---|
GROUP-ID | string | Required | Identifier for the Atlas project associated with the X.509 configuration. |
Query Parameters¶
The following query parameters are optional:
Query Parameter | Type | Description | Default |
---|---|---|---|
pretty | boolean | Displays response in a prettyprint format. | false |
envelope | boolean | Specifies whether or not to wrap the response in an envelope. | false |
Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Name | Type | Description |
---|---|---|
ldap | object | LDAP configuration for an Atlas project. To learn more about LDAP configuration options, see Get Current LDAP Configuration. |
customerX509 | object | Customer-managed X.509 configuration for an Atlas project. |
customerX509.cas | string | PEM string containing one or more customer CAs for database user authentication. |
Example¶
Request¶
The following example returns the current X.509 configuration details for an Atlas project.
curl --request GET \ --user "{publicApiKey}:{privateApiKey}" \ --digest "https://cloud.mongodb.com/api/atlas/v1.0/groups/{groupId}/userSecurity?pretty=true"
Response¶
The following partial example shows the JSON document returned:
1 { 2 "ldap" : {}, 3 "customerX509" : { 4 "cas" : "-----BEGIN CERTIFICATE-----\nMIICwjCCAaoCCQDUd
+4L8xlyXTANBgkqhkiG9w0BAQsFADAjMQ8wDQYDVQQDDAZy\nb290Q0ExEDAOBgN
...
+4IGl7MBfZ\nlpJl7/in79pUyXII907ZJNr6ghIXDbO1luVIXv7yyV13uDiw/
dA=\n-----END CERTIFICATE-----\n" 5 } 6 }