XmBindIdRequest

Shared parameters for a BindID request configuration.

@objc(XmBindIdRequest)

public class XmBindIdRequest : NSObject, Codable

Inheritance

Codable, NSObject

Properties

redirectUri

URL to which BindID will redirect on process completion, to convey results back to the calling application.

public var redirectUri: String!

nonce

Optional. A nonce value to be included in the generated ID Token. This is typically provided by the application backend, and can be used to ensure at the backend that the authentication response corresponds to a specific request issued by the application.

public var nonce: String?

state

Optional. A state value to be included in the BindID response issued through redirect. This is typically generated at the front-end, and verified at the front-end upon processing the redirect. This ensures that the redirect request corresponds to the BindID authentication request.

public var state: String?

scope

Optional. A set of BindID scopes that will include additional information in the result claims. If not provided, only 'Openid' scope is sent

public var scope: [XmBindIdScopeType]?

verifications

A collection of verifications to try and execute for this request. It is not guaranteed that each requested verification will be fulfilled. The acr claim of the resulting access token should be examined to determine which verifications were fulfilled.

public var verifications: [XmRequiredVerifications]?

customMessage

Optional. A custom message to present as part of the authentication context detail screen.

public var customMessage: String?

usePkce

Indicates if the BindID request will initiate a PKCE flow. In that case, the SDK will generate a code challenge using the S256 hashing algorithm and return the code verifier that can be used for a token exchange. Default is True.

public var usePkce: Bool!

encrypted

A flag indicates whether the authentication request should be encrypted.

public var encrypted: Bool?

loginHint

Optional. Type and value for the login hint, which is used as a hint for the user’s login identifier (e.g., their email address)

public var loginHint: XmBindIdLoginHint?

boundTo

Used to require an authenticating device bound to the Client Application for a specified user (e.g., for step-up authentication). This bound status is reflected in the ID token by the ts.bindid.app_bound_cred ACR value, which is set using a session-feedback request.

public var boundTo: XmBindIdBoundTo?