Class UsernamePasswordCredential

Namespace

MongoDB.Driver.Core.Authentication

Assembly

MongoDB.Driver.Core.dll

Represents a username/password credential.

public sealed class UsernamePasswordCredential

Inheritance

object

UsernamePasswordCredential

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

UsernamePasswordCredential(string, string, SecureString)

Initializes a new instance of the UsernamePasswordCredential class. 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. See Driver Authentication: SCRAM-SHA-256 for additional details.

public UsernamePasswordCredential(string source, string username, SecureString password)

Parameters

source string

The source.

username string

The username.

password SecureString

The password.

UsernamePasswordCredential(string, string, string)

Initializes a new instance of the UsernamePasswordCredential class.

public UsernamePasswordCredential(string source, string username, string password)

Parameters

source string

The source.

username string

The username.

password string

The password.

Properties

Password

Gets the password.

public SecureString Password { get; }

Property Value

SecureString

The password.

SaslPreppedPassword

Gets the the SASLprepped password. May create a cleartext copy of the password in managed memory the first time it is accessed. Use only as needed e.g. for SCRAM-SHA-256.

public SecureString SaslPreppedPassword { get; }

Property Value

SecureString

The SASLprepped password.

Source

Gets the source.

public string Source { get; }

Property Value

string

The source.

Username

Gets the username.

public string Username { get; }

Property Value

string

The username.

Methods

GetInsecurePassword()

Gets the password (converts the password from a SecureString to a regular string).

public string GetInsecurePassword()

Returns

string

The password.