MongoDB supports multiple mechanisms that you can use to authenticate your application. This page contains code examples that show each of these mechanisms.
To use an authentication example from this page, copy the code example into the sample application or your own application. Be sure to replace all placeholders in the code examples, such as <hostname>, with the relevant values for your MongoDB deployment.
You can use the following sample application to test the code examples on this page. To use the sample application, perform the following steps:
Ensure you have PyMongo installed.
Copy the following code and paste it into a new .py file.
Copy a code example from this page and paste it on the specified lines in the file.
Select the Synchronous or Asynchronous tab to see the corresponding code:
1from pymongo import MongoClient23try:4 56 78 client.admin.command("ping")9 print("Connected successfully")1011 1213 client.close()1415except Exception as e:16 raise Exception(17 "The following error occurred: ", e)1import asyncio2from pymongo import AsyncMongoClient34async def main():5 try:6 78 910 await client.admin.command("ping")11 print("Connected successfully")1213 1415 await client.close()1617 except Exception as e:18 raise Exception(19 "The following error occurred: ", e)2021asyncio.run(main())client = pymongo.MongoClient("mongodb://<db_username>:<db_password>@<hostname:<port>", tls=True)client = pymongo.MongoClient("mongodb://<db_username>:<db_password>@<hostname>:<port>?tls=true")client = pymongo.AsyncMongoClient("mongodb://<db_username>:<db_password>@<hostname:<port>", tls=True)client = pymongo.AsyncMongoClient("mongodb://<db_username>:<db_password>@<hostname>:<port>?tls=true")To learn more about enabling TLS, see Enable TLS in the TLS configuration guide.
client = pymongo.MongoClient("mongodb://<db_username>:<db_password>@<hostname>:<port>", tls=True, tlsCAFile="/path/to/ca.pem")uri = "mongodb://<db_username>:<db_password>@<hostname>:<port>/?tls=true&tlsCAFile=/path/to/ca.pem"client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<db_username>:<db_password>@<hostname>:<port>", tls=True, tlsCAFile="/path/to/ca.pem")uri = "mongodb://<db_username>:<db_password@<hostname>:<port>/?tls=true&tlsCAFile=/path/to/ca.pem"client = pymongo.AsyncMongoClient(uri)To learn more about specifying a CA file, see Specify a CA File in the TLS configuration guide.
client = pymongo.MongoClient("mongodb://<db_username>:<db_password>@<hostname>:<port>", tls=True, tlsDisableOCSPEndpointCheck=True)uri = "mongodb://example.com/?tls=true&tlsDisableOCSPEndpointCheck=true"client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<db_username>:<db_password>@<hostname>:<port>", tls=True, tlsDisableOCSPEndpointCheck=True)uri = "mongodb://example.com/?tls=true&tlsDisableOCSPEndpointCheck=true"client = pymongo.AsyncMongoClient(uri)To learn more about disabling OCSP checks, see OCSP in the TLS configuration guide.
client = pymongo.MongoClient("mongodb://<db_username>:<db_password>@<hostname>:<port>", tls=True, tlsCRLFile="/path/to/crl.pem")uri = "mongodb://example.com/?tls=true&tlsCRLFile=/path/to/crl.pem"client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<db_username>:<db_password>@<hostname>:<port>", tls=True, tlsCRLFile="/path/to/crl.pem")uri = "mongodb://example.com/?tls=true&tlsCRLFile=/path/to/crl.pem"client = pymongo.AsyncMongoClient(uri)To learn more about specifying a CRL, see Certificate Revocation List in the TLS configuration guide.
client = pymongo.MongoClient("mongodb://<db_username>:<db_password>@<hostname>:<port>", tls=True, tlsCertificateKeyFile='/path/to/client.pem')uri = ("mongodb://<db_username>:<db_password>@<hostname:<port>/?" "tls=true" "&tlsCertificateKeyFile=path/to/client.pem")client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<db_username>:<db_password>@<hostname>:<port>", tls=True, tlsCertificateKeyFile='/path/to/client.pem')uri = ("mongodb://<db_username>:<db_password>@<hostname>:<port>/?" "tls=true" "&tlsCertificateKeyFile=path/to/client.pem")client = pymongo.AsyncMongoClient(uri)To learn more about specifying a client certificate, see Present a Client Certificate in the TLS configuration guide.
client = pymongo.MongoClient("mongodb://<db_username>:<db_password>@<hostname:<port>", tls=True, tlsCertificateKeyFile='/path/to/client.pem', tlsCertificateKeyFilePassword=<passphrase>)uri = ("mongodb://<db_username>:<db_password>@<hostname:<port>/?" "tls=true" "&tlsCertificateKeyFile=path/to/client.pem" "&tlsCertificateKeyFilePassword=<passphrase>")client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<db_username>:<db_password>@<hostname>:<port>", tls=True, tlsCertificateKeyFile='/path/to/client.pem', tlsCertificateKeyFilePassword=<passphrase>)uri = ("mongodb://<db_username>:<db_password" "@<hostname>:<port>/?" "tls=true" "&tlsCertificateKeyFile=path/to/client.pem" "&tlsCertificateKeyFilePassword=<passphrase>")client = pymongo.AsyncMongoClient(uri)To learn more about providing a key file password, see Provide a Key Password in the TLS configuration guide.
client = pymongo.MongoClient("mongodb://<db_username>:<db_password>@<hostname:<port>", tls=True, tlsInsecure=True)uri = ("mongodb://<db_username>:<db_password>@<hostname>:<port>/?" "tls=true" "&tlsInsecure=true")client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<db_username>:<db_password>@<hostname>:<port>", tls=True, tlsInsecure=True)uri = ("mongodb://<db_username>:<db_password>@<hostname>:<port>/?" "tls=true" "&tlsInsecure=true")client = pymongo.AsyncMongoClient(uri)To learn more about allowing insecure TLS, see Allow Insecure TLS in the TLS configuration guide.
client = pymongo.MongoClient("mongodb://<db_username>:<db_password>@<hostname>:<port>", tls=True, tlsAllowInvalidCertificates=True)uri = ("mongodb://<db_username>:<db_password>@<hostname>:<port>/?" "tls=true" "&tlsAllowInvalidCertificates=true")client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<db_username>:<db_password>@<hostname>:<port>", tls=True, tlsAllowInvalidCertificates=True)uri = ("mongodb://<db_username>:<db_password>@<hostname>:<port>/?" "tls=true" "&tlsAllowInvalidCertificates=true")client = pymongo.AsyncMongoClient(uri)To learn more about disabling certificate validation, see Allow Insecure TLS in the TLS configuration guide.
client = pymongo.MongoClient("mongodb://<db_username>:<db_password>@<hostname>:<port>", tls=True, tlsAllowInvalidHostnames=True)uri = ("mongodb://<db_username>:<db_password>@<hostname>:<port>/?" "tls=true" "&tlsAllowInvalidHostnames=true")client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<db_username>:<db_password>@<hostname>:<port>", tls=True, tlsAllowInvalidHostnames=True)uri = ("mongodb://<db_username>:<db_password>@<hostname>:<port>/?" "tls=true" "&tlsAllowInvalidHostnames=true")client = pymongo.AsyncMongoClient(uri)To learn more about disabling hostname verification, see Allow Insecure TLS in the TLS configuration guide.
client = pymongo.MongoClient("mongodb://<hostname>:<port>", username="<db_username>", password="<db_password>", authSource="<authentication database>", authMechanism="SCRAM-SHA-256")uri = ("mongodb://<percent-encoded username>:<percent-encoded password>" "@<hostname>:<port>/?" "authSource=<authentication database>" "&authMechanism=SCRAM-SHA-256")client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<hostname>:<port>", username="<db_username>", password="<db_password>", authSource="<authentication database>", authMechanism="SCRAM-SHA-256")uri = ("mongodb://<percent-encoded username>:<percent-encoded password>" "@<hostname>:<port>/?" "authSource=<authentication database>" "&authMechanism=SCRAM-SHA-256")client = pymongo.AsyncMongoClient(uri)To learn more about SCRAM-SHA-256 authentication, see SCRAM in the Authentication guide.
client = pymongo.MongoClient("mongodb://<hostname>:<port>", username="<db_username>", password="<db_password>", authSource="<authentication database>", authMechanism="SCRAM-SHA-1")uri = ("mongodb://<percent-encoded username>:<percent-encoded password>" "@<hostname>:<port>/?" "authSource=<authentication database>" "&authMechanism=SCRAM-SHA-1")client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<hostname>:<port>", username="<db_username>", password="<db_password>", authSource="<authentication database>", authMechanism="SCRAM-SHA-1")uri = ("mongodb://<percent-encoded username>:<percent-encoded password>" "@<hostname>:<port>/?" "authSource=<authentication database>" "&authMechanism=SCRAM-SHA-1")client = pymongo.AsyncMongoClient(uri)To learn more about SCRAM-SHA-1 authentication, see SCRAM in the Authentication guide.
client = pymongo.MongoClient("mongodb://<hostname>:<port>", tls=True, tlsCertificateKeyFile="/path/to/client.pem", authMechanism="MONGODB-X509")uri = ("mongodb://<hostname>:<port>/?" "tls=true" "&tlsCertificateKeyFile=path/to/client.pem" "&authMechanism=MONGODB-X509")client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<hostname>:<port>", tls=True, tlsCertificateKeyFile="/path/to/client.pem", authMechanism="MONGODB-X509")uri = ("mongodb://<hostname>:<port>/?" "tls=true" "&tlsCertificateKeyFile=path/to/client.pem" "&authMechanism=MONGODB-X509")client = pymongo.AsyncMongoClient(uri)To learn more about MONGODB-X509 authentication, see X.509 in the Authentication guide.
client = pymongo.MongoClient("mongodb://<hostname>:<port>", username="<AWS IAM access key ID>", password="<AWS IAM secret access key>", authMechanism="MONGODB-AWS")uri = ("mongodb://<percent-encoded AWS IAM access key ID>:" "<percent-encoded AWS IAM secret access key>" "@<hostname>:<port>/?" "&authMechanism=MONGODB-AWS")client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<hostname>:<port>", username="<AWS IAM access key ID>", password="<AWS IAM secret access key>", authMechanism="MONGODB-AWS")uri = ("mongodb://<percent-encoded AWS IAM access key ID>:" "<percent-encoded AWS IAM secret access key>" "@<hostname>:<port>/?" "&authMechanism=MONGODB-AWS")client = pymongo.AsyncMongoClient(uri)To learn more about authenticating with AWS MongoClient credentials, see MongoClient Credentials in the Authentication guide.
client = pymongo.MongoClient("mongodb://<hostname>:<port>", authMechanism="MONGODB-AWS")uri = "mongodb://<hostname>:<port>/?&authMechanism=MONGODB-AWS"client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<hostname>:<port>", authMechanism="MONGODB-AWS")uri = "mongodb://<hostname>:<port>/?&authMechanism=MONGODB-AWS"client = pymongo.AsyncMongoClient(uri)To learn more about authenticating with AWS environment variables, see Environment Variables in the Authentication guide.
client = pymongo.MongoClient("mongodb://<hostname>:<port>", authMechanism="MONGODB-AWS")uri = "mongodb://<hostname>:<port>/?&authMechanism=MONGODB-AWS"client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<hostname>:<port>", authMechanism="MONGODB-AWS")uri = "mongodb://<hostname>:<port>/?&authMechanism=MONGODB-AWS"client = pymongo.AsyncMongoClient(uri)To learn more about authenticating with a shared AWS credentials file, see Shared Credentials File in the Authentication guide.
client = pymongo.MongoClient("mongodb://<hostname>:<port>", authMechanism="MONGODB-AWS")uri = "mongodb://<hostname>:<port>/?&authMechanism=MONGODB-AWS"client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<hostname>:<port>", authMechanism="MONGODB-AWS")uri = "mongodb://<hostname>:<port>/?&authMechanism=MONGODB-AWS"client = pymongo.AsyncMongoClient(uri)To learn more about authenticating with an AWS config file, see AWS Config File in the Authentication guide.
client = pymongo.MongoClient("mongodb://@<hostname>:<port>", username="<AWS IAM access key ID>", password="<AWS IAM secret access key>", authMechanismProperties="AWS_SESSION_TOKEN:<AWS session token>", authMechanism="MONGODB-AWS")uri = ("mongodb://<percent-encoded AWS IAM access key ID>:" "<percent-encoded AWS IAM secret access key>" "@<hostname>:<port>/?" "authMechanismProperties=AWS_SESSION_TOKEN:<AWS session token>" "&authMechanism=MONGODB-AWS")client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://@<hostname>:<port>", username="<AWS IAM access key ID>", password="<AWS IAM secret access key>", authMechanismProperties="AWS_SESSION_TOKEN:<AWS session token>", authMechanism="MONGODB-AWS")uri = ("mongodb://<percent-encoded AWS IAM access key ID>:" "<percent-encoded AWS IAM secret access key>" "@<hostname>:<port>/?" "authMechanismProperties=AWS_SESSION_TOKEN:<AWS session token>" "&authMechanism=MONGODB-AWS")client = pymongo.AsyncMongoClient(uri)To learn more about authenticating with an AssumeRole request, see AssumeRole Request in the Authentication guide.
client = pymongo.MongoClient("mongodb://<hostname>:<port>", authMechanism="MONGODB-AWS")uri = "mongodb://<hostname>:<port>/?&authMechanism=MONGODB-AWS"client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<hostname>:<port>", authMechanism="MONGODB-AWS")uri = "mongodb://<hostname>:<port>/?&authMechanism=MONGODB-AWS"client = pymongo.AsyncMongoClient(uri)To learn more about authenticating with an AssumeRoleWithWebIdentity request, see AssumeRoleWithWebIdentity in the Authentication guide.
client = pymongo.MongoClient("mongodb://<hostname>:<port>", authMechanism="MONGODB-AWS")uri = "mongodb://<hostname>:<port>/?&authMechanism=MONGODB-AWS"client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<hostname>:<port>", authMechanism="MONGODB-AWS")uri = "mongodb://<hostname>:<port>/?&authMechanism=MONGODB-AWS"client = pymongo.AsyncMongoClient(uri)To learn more about authenticating from an ECS container, see ECS Container or EC2 Instance in the Authentication guide.
Note MongoDB Enterprise OnlyKerberos authentication is available only in MongoDB Enterprise.
client = pymongo.MongoClient("mongodb://<hostname>:<port>", username="mongodbuser@EXAMPLE.COM", authMechanism="GSSAPI", authMechanismProperties="SERVICE_NAME:<authentication service name>")uri = ("mongodb://mongodbuser%40EXAMPLE.COM@<hostname>:<port>/?" "&authMechanism=GSSAPI" "&authMechanismProperties=SERVICE_NAME:<authentication service name>")client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<hostname>:<port>", username="mongodbuser@EXAMPLE.COM", authMechanism="GSSAPI", authMechanismProperties="SERVICE_NAME:<authentication service name>")uri = ("mongodb://mongodbuser%40EXAMPLE.COM@<hostname>:<port>/?" "&authMechanism=GSSAPI" "&authMechanismProperties=SERVICE_NAME:<authentication service name>")client = pymongo.AsyncMongoClient(uri)To learn more about authenticating with Kerberos, see Kerberos (GSSAPI) in the Enterprise Authentication guide.
client = pymongo.MongoClient("mongodb://<hostname>:<port>", username="<username>", authMechanism="GSSAPI", password="<password>", authMechanismProperties="SERVICE_NAME:<authentication service name>, CANONICALIZE_HOST_NAME:true, SERVICE_REALM:<service realm>")uri = ("mongodb://<percent-encoded username>:<percent-encoded user password>" "@<hostname>:<port>/?" "&authMechanism=GSSAPI" "&authMechanismProperties=" "SERVICE_NAME:<authentication service name>," "CANONICALIZE_HOST_NAME:true," "SERVICE_REALM:<service realm>")client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<hostname>:<port>", username="<username>", authMechanism="GSSAPI", password="<password>", authMechanismProperties="SERVICE_NAME:<authentication service name>, CANONICALIZE_HOST_NAME:true, SERVICE_REALM:<service realm>")uri = ("mongodb://<percent-encoded username>:<percent-encoded user password>" "@<hostname>:<port>/?" "&authMechanism=GSSAPI" "&authMechanismProperties=" "SERVICE_NAME:<authentication service name>," "CANONICALIZE_HOST_NAME:true," "SERVICE_REALM:<service realm>")client = pymongo.AsyncMongoClient(uri)To learn more about authenticating with Kerberos, see Kerberos (GSSAPI) in the Enterprise Authentication guide.
Note MongoDB Enterprise OnlyPLAIN SASL authentication is available only in MongoDB Enterprise.
client = pymongo.MongoClient("mongodb://<hostname>:<port>", username="<username>", password="<password>", authMechanism="PLAIN", tls=True)uri = ("mongodb://<username>:<password>@<hostname>:<port>/?" "&authMechanism=PLAIN" "&tls=true")client = pymongo.MongoClient(uri)client = pymongo.AsyncMongoClient("mongodb://<hostname>:<port>", username="<username>", password="<password>", authMechanism="PLAIN", tls=True)uri = ("mongodb://<username>:<password>@<hostname>:<port>/?" "&authMechanism=PLAIN" "&tls=true")client = pymongo.AsyncMongoClient(uri)To learn more about authenticating with PLAIN SASL, see LDAP (PLAIN SASL) in the Enterprise Authentication guide.
Note MongoDB Enterprise OnlyMONGODB-OIDC authentication is available only in MongoDB Enterprise.
from pymongo import MongoClientproperties = {"ENVIRONMENT": "azure", "TOKEN_RESOURCE": "<audience>"}client = MongoClient( "mongodb[+srv]://<hostname>:<port>", username="<Azure ID>", authMechanism="MONGODB-OIDC", authMechanismProperties=properties)from pymongo import MongoClienturi = ("mongodb[+srv]://<hostname>:<port>/?" "username=<username>" "&authMechanism=MONGODB-OIDC" "&authMechanismProperties=ENVIRONMENT:azure,TOKEN_RESOURCE:<percent-encoded audience>")client = MongoClient(uri)from pymongo import AsyncMongoClientproperties = {"ENVIRONMENT": "azure", "TOKEN_RESOURCE": "<audience>"}client = AsyncMongoClient( "mongodb[+srv]://<hostname>:<port>", username="<Azure ID>", authMechanism="MONGODB-OIDC", authMechanismProperties=properties)from pymongo import AsyncMongoClienturi = ("mongodb[+srv]://<hostname>:<port>/?" "username=<username>" "&authMechanism=MONGODB-OIDC" "&authMechanismProperties=ENVIRONMENT:azure,TOKEN_RESOURCE:<percent-encoded audience>")client = AsyncMongoClient(uri)To learn more about authenticating with OIDC, see Azure IMDS in the Authentication guide.
from pymongo import MongoClientproperties = {"ENVIRONMENT": "gcp", "TOKEN_RESOURCE": "<audience>"}client = MongoClient( "mongodb[+srv]://<hostname>:<port>", authMechanism="MONGODB-OIDC", authMechanismProperties=properties)from pymongo import MongoClienturi = ("mongodb[+srv]://<hostname>:<port>/?" "&authMechanism=MONGODB-OIDC" "&authMechanismProperties=ENVIRONMENT:gcp,TOKEN_RESOURCE:<percent-encoded audience>")client = MongoClient(uri)from pymongo import AsyncMongoClientproperties = {"ENVIRONMENT": "gcp", "TOKEN_RESOURCE": "<audience>"}client = AsyncMongoClient( "mongodb[+srv]://<hostname>:<port>", authMechanism="MONGODB-OIDC", authMechanismProperties=properties)from pymongo import AsyncMongoClienturi = ("mongodb[+srv]://<hostname>:<port>/?" "&authMechanism=MONGODB-OIDC" "&authMechanismProperties=ENVIRONMENT:gcp,TOKEN_RESOURCE:<percent-encoded audience>")client = AsyncMongoClient(uri)To learn more about authenticating with OIDC, see GCP IMDS in the Authentication guide.
from pymongo import MongoClientfrom azure.identity import DefaultAzureCredentialfrom pymongo.auth_oidc import OIDCCallback, OIDCCallbackContext, OIDCCallbackResult audience = "<audience>"client_id = "<Azure ID>"class MyCallback(OIDCCallback): def fetch(self, context: OIDCCallbackContext) -> OIDCCallbackResult: credential = DefaultAzureCredential(managed_identity_client_id=client_id) token = credential.get_token(f"{audience}/.default").token return OIDCCallbackResult(access_token=token) properties = {"OIDC_CALLBACK": MyCallback()}client = MongoClient( "mongodb[+srv]://<hostname>:<port>", authMechanism="MONGODB-OIDC", authMechanismProperties=properties)from pymongo import AsyncMongoClientfrom azure.identity import DefaultAzureCredentialfrom pymongo.auth_oidc import OIDCCallback, OIDCCallbackContext, OIDCCallbackResult audience = "<audience>"client_id = "<Azure ID>"class MyCallback(OIDCCallback): def fetch(self, context: OIDCCallbackContext) -> OIDCCallbackResult: credential = DefaultAzureCredential(managed_identity_client_id=client_id) token = credential.get_token(f"{audience}/.default").token return OIDCCallbackResult(access_token=token) properties = {"OIDC_CALLBACK": MyCallback()}client = AsyncMongoClient( "mongodb[+srv]://<hostname>:<port>", authMechanism="MONGODB-OIDC", authMechanismProperties=properties)To learn more about authenticating with OIDC, see Other Azure Environments in the Authentication guide.
from pymongo import MongoClientfrom pymongo.auth_oidc import OIDCCallback, OIDCCallbackContext, OIDCCallbackResult class MyCallback(OIDCCallback): def fetch(self, context: OIDCCallbackContext) -> OIDCCallbackResult: with open("/var/run/secrets/kubernetes.io/serviceaccount/token") as fid: token = fid.read() return OIDCCallbackResult(access_token=token)properties = {"OIDC_CALLBACK": MyCallback()}client = MongoClient( "mongodb[+srv]://<hostname>:<port>", authMechanism="MONGODB-OIDC", authMechanismProperties=properties)from pymongo import AsyncMongoClientfrom pymongo.auth_oidc import OIDCCallback, OIDCCallbackContext, OIDCCallbackResult class MyCallback(OIDCCallback): def fetch(self, context: OIDCCallbackContext) -> OIDCCallbackResult: with open("/var/run/secrets/kubernetes.io/serviceaccount/token") as fid: token = fid.read() return OIDCCallbackResult(access_token=token)properties = {"OIDC_CALLBACK": MyCallback()}client = AsyncMongoClient( "mongodb[+srv]://<hostname>:<port>", authMechanism="MONGODB-OIDC", authMechanismProperties=properties)To learn more about authenticating with OIDC, see GCP GKE in the Authentication guide.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4