MongoCredential Class |
Credential to access a MongoDB database.
Inheritance HierarchyNamespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.7.3+Branch.v2.7.x.Sha.2f1f2be13a23b8520cb9c2ee8439c022f9a03efe
SyntaxThe MongoCredential type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MongoCredential |
Initializes a new instance of the MongoCredential class.
|
Properties| Name | Description | |
|---|---|---|
 | Evidence |
Gets the evidence.
|
| Identity |
Gets the identity.
|
| Mechanism |
Gets the mechanism to authenticate with.
In .NET Standard, authenticating via SCRAM-SHA-256 may not work with non-ASCII passwords because SaslPrep is
not fully implemented due to the lack of a string normalization function in .NET Standard 1.5.
Normalizing the password into Unicode Normalization Form KC beforehand MAY help.
SCRAM-SHA-1 is the recommended alternative for now.
|
| Password | Obsolete.
Gets the password.
|
| Source |
Gets the source.
|
| Username |
Gets the username.
|
Methods| Name | Description | |
|---|---|---|
 | CreateCredential(String, String, SecureString) |
Creates a default credential.
Less secure when used in conjunction with SCRAM-SHA-256, due to the need to store the password in a managed
string in order to SaslPrep it.
In .NET Standard, authenticating via SCRAM-SHA-256 may not work with non-ASCII passwords because SaslPrep is
not fully implemented due to the lack of a string normalization function in .NET Standard 1.5.
Normalizing the password into Unicode Normalization Form KC beforehand MAY help.
SCRAM-SHA-1 is the recommended alternative for now.
|
| CreateCredential(String, String, String) |
Creates a default credential.
In .NET Standard, authenticating via SCRAM-SHA-256 may not work with non-ASCII passwords because SaslPrep is
not fully implemented due to the lack of a string normalization function in .NET Standard 1.5.
Normalizing the password into Unicode Normalization Form KC beforehand MAY help.
SCRAM-SHA-1 is the recommended alternative for now.
|
| CreateGssapiCredential(String) |
Creates a GSSAPI credential.
|
| CreateGssapiCredential(String, SecureString) |
Creates a GSSAPI credential.
|
| CreateGssapiCredential(String, String) |
Creates a GSSAPI credential.
|
| CreateMongoCRCredential(String, String, SecureString) | Obsolete.
Creates a credential used with MONGODB-CR.
|
| CreateMongoCRCredential(String, String, String) | Obsolete.
Creates a credential used with MONGODB-CR.
|
| CreateMongoX509Credential |
Creates a credential used with MONGODB-X509.
|
| CreatePlainCredential(String, String, SecureString) |
Creates a PLAIN credential.
|
| CreatePlainCredential(String, String, String) |
Creates a PLAIN credential.
|
| Equals(Object) |
Compares this MongoCredential to another MongoCredential.
(Overrides ObjectEquals(Object).) |
| Equals(MongoCredential) |
Compares this MongoCredential to another MongoCredential.
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode |
Gets the hashcode for the credential.
(Overrides ObjectGetHashCode.) |
| GetMechanismPropertyT |
Gets the mechanism property.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString |
Returns a string representation of the credential.
(Overrides ObjectToString.) |
| WithMechanismProperty |
Creates a new MongoCredential with the specified mechanism property.
|
Operators| Name | Description | |
|---|---|---|
 | Equality |
Compares two MongoCredentials.
|
| Inequality |
Compares two MongoCredentials.
|
Extension Methods| Name | Description | |
|---|---|---|
 | ToBson |
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.) |
| ToBsonDocument |
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.) |
| ToJson |
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.) |
See Also