ScramShaAuthenticator Class |
A SCRAM-SHA SASL authenticator.
Inheritance HierarchySystemObject
MongoDB.Driver.Core.AuthenticationSaslAuthenticator
MongoDB.Driver.Core.AuthenticationScramShaAuthenticator
MongoDB.Driver.Core.AuthenticationScramSha1Authenticator
MongoDB.Driver.Core.AuthenticationScramSha256Authenticator
MongoDB.Driver.Core.AuthenticationSaslAuthenticator
MongoDB.Driver.Core.AuthenticationScramShaAuthenticator
MongoDB.Driver.Core.AuthenticationScramSha1Authenticator
MongoDB.Driver.Core.AuthenticationScramSha256Authenticator
Namespace: MongoDB.Driver.Core.Authentication
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
SyntaxThe ScramShaAuthenticator type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ScramShaAuthenticator(UsernamePasswordCredential, HashAlgorithmName, ScramShaAuthenticatorH, ScramShaAuthenticatorHi, ScramShaAuthenticatorHmac) | Obsolete.
Initializes a new instance of the ScramShaAuthenticator class.
|
| ScramShaAuthenticator(UsernamePasswordCredential, HashAlgorithmName, ScramShaAuthenticatorH, ScramShaAuthenticatorHi, ScramShaAuthenticatorHmac, ServerApi) |
Initializes a new instance of the ScramShaAuthenticator class.
|
Properties| Name | Description | |
|---|---|---|
 | DatabaseName |
Gets the name of the database.
(Overrides SaslAuthenticatorDatabaseName.) |
| Name |
Gets the name of the authenticator.
(Inherited from SaslAuthenticator.) |
Methods| Name | Description | |
|---|---|---|
 | Authenticate |
Authenticates the connection.
(Inherited from SaslAuthenticator.) |
| AuthenticateAsync |
Authenticates the connection.
(Inherited from SaslAuthenticator.) |
| CustomizeInitialHelloCommand |
Optionally customizes hello or legacy hello command.
(Overrides SaslAuthenticatorCustomizeInitialHelloCommand(BsonDocument).) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| 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 | Serves as the default hash function. (Inherited from Object.) |
| 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 that represents the current object. (Inherited from Object.) |
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