Contains information about the authentication status. More...

Inheritance diagram for DocuSign.eSign.Model.AuthenticationStatus:

Public Member Functions
	AuthenticationStatus (EventResult AccessCodeResult=default(EventResult), EventResult AgeVerifyResult=default(EventResult), EventResult AnySocialIDResult=default(EventResult), EventResult FacebookResult=default(EventResult), EventResult GoogleResult=default(EventResult), EventResult IdentityVerificationResult=default(EventResult), EventResult IdLookupResult=default(EventResult), EventResult IdQuestionsResult=default(EventResult), EventResult LinkedinResult=default(EventResult), EventResult LiveIDResult=default(EventResult), EventResult OfacResult=default(EventResult), EventResult OpenIDResult=default(EventResult), EventResult PhoneAuthResult=default(EventResult), EventResult SalesforceResult=default(EventResult), EventResult SignatureProviderResult=default(EventResult), EventResult SmsAuthResult=default(EventResult), EventResult STANPinResult=default(EventResult), EventResult TwitterResult=default(EventResult), EventResult YahooResult=default(EventResult))
	Initializes a new instance of the AuthenticationStatus class. More...

override string	ToString ()
	Returns the string presentation of the object More...

string	ToJson ()
	Returns the JSON string presentation of the object More...

override bool	Equals (object obj)
	Returns true if objects are equal More...

bool	Equals (AuthenticationStatus other)
	Returns true if AuthenticationStatus instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
EventResult	AccessCodeResult `[get, set]`
	The result of a user's attempt to authenticate by using an access code. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. More...

EventResult	AgeVerifyResult `[get, set]`
	The result of an age verification check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. More...

EventResult	AnySocialIDResult `[get, set]`
	Deprecated. More...

EventResult	FacebookResult `[get, set]`
	Deprecated. More...

EventResult	GoogleResult `[get, set]`
	Deprecated. More...

EventResult	IdentityVerificationResult `[get, set]`
	The result of an [Identity Verification][IDV] workflow. [IDV]: /docs/esign-rest-api/reference/accounts/identityverifications/ More...

EventResult	IdLookupResult `[get, set]`
	The result of an ID lookup authentication check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. More...

EventResult	IdQuestionsResult `[get, set]`
	The result of the user's answers to ID challenge questions. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. More...

EventResult	LinkedinResult `[get, set]`
	Deprecated. More...

EventResult	LiveIDResult `[get, set]`
	Deprecated. More...

EventResult	OfacResult `[get, set]`
	The result of an Office of Foreign Asset Control (OFAC) check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. More...

EventResult	OpenIDResult `[get, set]`
	Deprecated. More...

EventResult	PhoneAuthResult `[get, set]`
	The result of the user's attempt to authenticate by using two-factor authentication (2FA) through phone messaging. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. More...

EventResult	SalesforceResult `[get, set]`
	Success/failure result of authentication using sign-in with a Salesforce account. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. More...

EventResult	SignatureProviderResult `[get, set]`
	The result of the user's attempt to authenticate by using a signature provider. More...

EventResult	SmsAuthResult `[get, set]`
	The result of the user's attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone. More...

EventResult	STANPinResult `[get, set]`
	The result of a Student Authentication Network (STAN) authentication check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. More...

EventResult	TwitterResult `[get, set]`
	Deprecated. More...

EventResult	YahooResult `[get, set]`
	Deprecated. More...

Detailed Description

Contains information about the authentication status.

Constructor & Destructor Documentation

◆ AuthenticationStatus()

DocuSign.eSign.Model.AuthenticationStatus.AuthenticationStatus	(	EventResult	AccessCodeResult = `default(EventResult)`,
		EventResult	AgeVerifyResult = `default(EventResult)`,
		EventResult	AnySocialIDResult = `default(EventResult)`,
		EventResult	FacebookResult = `default(EventResult)`,
		EventResult	GoogleResult = `default(EventResult)`,
		EventResult	IdentityVerificationResult = `default(EventResult)`,
		EventResult	IdLookupResult = `default(EventResult)`,
		EventResult	IdQuestionsResult = `default(EventResult)`,
		EventResult	LinkedinResult = `default(EventResult)`,
		EventResult	LiveIDResult = `default(EventResult)`,
		EventResult	OfacResult = `default(EventResult)`,
		EventResult	OpenIDResult = `default(EventResult)`,
		EventResult	PhoneAuthResult = `default(EventResult)`,
		EventResult	SalesforceResult = `default(EventResult)`,
		EventResult	SignatureProviderResult = `default(EventResult)`,
		EventResult	SmsAuthResult = `default(EventResult)`,
		EventResult	STANPinResult = `default(EventResult)`,
		EventResult	TwitterResult = `default(EventResult)`,
		EventResult	YahooResult = `default(EventResult)`
	)

inline

Initializes a new instance of the AuthenticationStatus class.

Parameters

AccessCodeResult	The result of a user's attempt to authenticate by using an access code. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. .
AgeVerifyResult	The result of an age verification check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. .
AnySocialIDResult	Deprecated..
FacebookResult	Deprecated..
GoogleResult	Deprecated..
IdentityVerificationResult	The result of an [Identity Verification][IDV] workflow. [IDV]: /docs/esign-rest-api/reference/accounts/identityverifications/.
IdLookupResult	The result of an ID lookup authentication check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. .
IdQuestionsResult	The result of the user's answers to ID challenge questions. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. .
LinkedinResult	Deprecated..
LiveIDResult	Deprecated..
OfacResult	The result of an Office of Foreign Asset Control (OFAC) check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. .
OpenIDResult	Deprecated..
PhoneAuthResult	The result of the user's attempt to authenticate by using two-factor authentication (2FA) through phone messaging. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. .
SalesforceResult	Success/failure result of authentication using sign-in with a Salesforce account. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. .
SignatureProviderResult	The result of the user's attempt to authenticate by using a signature provider..
SmsAuthResult	The result of the user's attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone..
STANPinResult	The result of a Student Authentication Network (STAN) authentication check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. .
TwitterResult	Deprecated..
YahooResult	Deprecated..

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.AuthenticationStatus.Equals ( object obj )

inline

Returns true if objects are equal

Parameters

obj	Object to be compared

Returns: Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.AuthenticationStatus.Equals ( AuthenticationStatus other )

inline

Returns true if AuthenticationStatus instances are equal

Parameters

other Instance of AuthenticationStatus to be compared

Returns: Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.AuthenticationStatus.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

string DocuSign.eSign.Model.AuthenticationStatus.ToJson ( )

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.AuthenticationStatus.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AccessCodeResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.AccessCodeResult

getset

The result of a user's attempt to authenticate by using an access code. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.

◆ AgeVerifyResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.AgeVerifyResult

getset

The result of an age verification check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.

◆ AnySocialIDResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.AnySocialIDResult

getset

Deprecated.

◆ FacebookResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.FacebookResult

getset

Deprecated.

◆ GoogleResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.GoogleResult

getset

Deprecated.

◆ IdentityVerificationResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.IdentityVerificationResult

getset

The result of an [Identity Verification][IDV] workflow. [IDV]: /docs/esign-rest-api/reference/accounts/identityverifications/

◆ IdLookupResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.IdLookupResult

getset

The result of an ID lookup authentication check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.

◆ IdQuestionsResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.IdQuestionsResult

getset

The result of the user's answers to ID challenge questions. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.

◆ LinkedinResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.LinkedinResult

getset

Deprecated.

◆ LiveIDResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.LiveIDResult

getset

Deprecated.

◆ OfacResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.OfacResult

getset

The result of an Office of Foreign Asset Control (OFAC) check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.

◆ OpenIDResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.OpenIDResult

getset

Deprecated.

◆ PhoneAuthResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.PhoneAuthResult

getset

The result of the user's attempt to authenticate by using two-factor authentication (2FA) through phone messaging. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.

◆ SalesforceResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.SalesforceResult

getset

Success/failure result of authentication using sign-in with a Salesforce account. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.

◆ SignatureProviderResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.SignatureProviderResult

getset

The result of the user's attempt to authenticate by using a signature provider.

◆ SmsAuthResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.SmsAuthResult

getset

The result of the user's attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone.

◆ STANPinResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.STANPinResult

getset

The result of a Student Authentication Network (STAN) authentication check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.

◆ TwitterResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.TwitterResult

getset

Deprecated.

◆ YahooResult

EventResult DocuSign.eSign.Model.AuthenticationStatus.YahooResult

getset

Deprecated.

The documentation for this class was generated from the following file:

sdk/src/DocuSign.eSign/Model/AuthenticationStatus.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ AuthenticationStatus()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AccessCodeResult

◆ AgeVerifyResult

◆ AnySocialIDResult

◆ FacebookResult

◆ GoogleResult

◆ IdentityVerificationResult

◆ IdLookupResult

◆ IdQuestionsResult

◆ LinkedinResult

◆ LiveIDResult

◆ OfacResult

◆ OpenIDResult

◆ PhoneAuthResult

◆ SalesforceResult

◆ SignatureProviderResult

◆ SmsAuthResult

◆ STANPinResult

◆ TwitterResult

◆ YahooResult