API version:
Show / Hide Table of Contents

Class AuthenticateOptions

This class contains all the request parameters for performing a primary authentication request

Inheritance
System.Object
AuthenticateOptions
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Okta.Auth.Sdk
Assembly: Okta.Auth.Sdk.dll
Syntax
public class AuthenticateOptions

Properties

Audience

Gets or sets the audience

Declaration
public string Audience { get; set; }
Property Value
Type Description
System.String

The audience

DeviceFingerprint

Gets or sets the device fingerprint

Declaration
public string DeviceFingerprint { get; set; }
Property Value
Type Description
System.String

The device fingerprint

DeviceToken

Gets or sets the device token

Declaration
public string DeviceToken { get; set; }
Property Value
Type Description
System.String

The device token

MultiOptionalFactorEnroll

Gets or sets the multiOptionalFactorEnroll flag

Declaration
public bool? MultiOptionalFactorEnroll { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

The multiOptionalFactorEnroll flag

Remarks

https://developer.okta.com/docs/api/resources/authn#options-object

Password

Gets or sets the password

Declaration
public string Password { get; set; }
Property Value
Type Description
System.String

The password

RelayState

Gets or sets the relay state

Declaration
public string RelayState { get; set; }
Property Value
Type Description
System.String

The relay state

StateToken

Gets or sets the state token

Declaration
public string StateToken { get; set; }
Property Value
Type Description
System.String

The state token

UserAgent

Gets or sets the user agent.

Declaration
public string UserAgent { get; set; }
Property Value
Type Description
System.String

The user agent.

Username

Gets or sets the username

Declaration
public string Username { get; set; }
Property Value
Type Description
System.String

The username

WarnBeforePasswordExpired

Gets or sets the warnBeforePasswordExpired flag

Declaration
public bool? WarnBeforePasswordExpired { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

The warnBeforePasswordExpired flag

Remarks

https://developer.okta.com/docs/api/resources/authn#options-object

XForwardedFor

Gets or sets the value for x-forwarded-for header.

Declaration
public string XForwardedFor { get; set; }
Property Value
Type Description
System.String

The value for x-forwarded-for header.

Back to top Copyright © 2021 Okta, Inc.
Generated with DocFx.