Navigation

Get Current X.509 Configuration

Get the current customer-managed X.509 configuration details for an Atlas project.

Info With Circle IconCreated with Sketch.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.

You must have the Atlas admin role to use this endpoint.

Info With Circle IconCreated with Sketch.Note

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
ParameterTypeNecessityDescription
GROUP-IDstringRequiredIdentifier for the Atlas project associated with the X.509 configuration.

The following query parameters are optional:

Query ParameterTypeDescriptionDefault
prettybooleanDisplays response in a prettyprint format.false
envelopebooleanSpecifies whether or not to wrap the response in an envelope.false

This endpoint does not use HTTP request body parameters.

NameTypeDescription
ldapobjectLDAP configuration for an Atlas project. To learn more about LDAP configuration options, see Get Current LDAP Configuration.
customerX509objectCustomer-managed X.509 configuration for an Atlas project.
customerX509.casstringPEM string containing one or more customer CAs for database user authentication.

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"

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}
Give Feedback