Protocols

Representation of an authenticated account in the Microsoft identity platform. Use MSALAccount to query information about the account, like username or id_token claims. Store identifier for getting tokens silently from MSAL at a later point.

Undocumented

Use this protocol if you have external account storage in addition to MSAL account storage. For example, if you find yourself in situation where on each MSAL completion block invocation you are updating accounts in your own storage, it might be beneficial to instead use MSALExternalAccountProviding extensibility feature.

A protocol that objects adopt to provide deserialization from JSON.

A protocol that objects adopt to provide serialization to JSON.

Class implementing MSALSerializedADALCacheProviderDelegate is responsible for persistence and management of ADAL cache on macOS

Undocumented

Protocol that defines the methods of a Credentials delegate

Undocumented

Undocumented

Protocol that defines the methods of a MFARequestChallenge delegate

Protocol that defines the methods of a MFAGetAuthMethodsDelegate delegate

Protocol that defines the methods of a ResetPasswordStart delegate

Protocol that defines the methods of a ResetPasswordVerifyCode delegate

Protocol that defines the methods of a ResetPasswordResendCode delegate

Protocol that defines the methods of a ResetPasswordRequired delegate

Protocol that defines the methods of a SignInAfterResetPassword delegate

Protocol that defines the methods of a SignInAfterSignUp delegate

Protocol that defines the methods of a SignInStart delegate

Protocol that defines the methods of a SignInPasswordRequired delegate

Protocol that defines the methods of a SignInResendCode delegate

Protocol that defines the methods of a SignInVerifyCode delegate

Protocol that defines the methods of a SignUpStart delegate

Protocol that defines the methods of a SignUpVerifyCode delegate

Protocol that defines the methods of a SignUpResendCode delegate

Protocol that defines the methods of a SignUpPasswordRequired delegate

Protocol that defines the methods of a SignUpAttributesRequired delegate

Shared base delegate for all Native Auth V2 (server-driven) flows.

Unlike V1 - which exposes a different delegate protocol per step - V2 uses one family of delegates for sign up, sign in and reset password. The SDK drives the flow and reports back through these callbacks; the app reacts and continues the flow by calling methods directly on the MSALNativeAuthState it is handed.

This base protocol declares only the two terminal callbacks (onFlowCompleted(result:scenario:) and onFlowError(error:scenario:)) that every flow reports. Each server-driven state is delivered through its own per-state delegate protocol (e.g. MSALNativeAuthCodeRequiredDelegate) that extends this base and adds a single strongly-typed, required callback. The app conforms to the per-state protocols for the states it wants to handle; if it does not conform to a state’s protocol, onFlowError(error:scenario:) is called with error type notImplemented.

All callbacks are invoked on the main actor.

Per-state delegate for the MSALNativeAuthAttributesInvalidState step of a Native Auth V2 flow.

Conform to this protocol (in addition to the terminal callbacks inherited from MSALNativeAuthFlowDelegate) to handle this state. Conforming is opt-in per state, but the callback is required once you conform.

Per-state delegate for the MSALNativeAuthAttributesRequiredState step of a Native Auth V2 flow.

Conform to this protocol (in addition to the terminal callbacks inherited from MSALNativeAuthFlowDelegate) to handle this state. Conforming is opt-in per state, but the callback is required once you conform.

Per-state delegate for the MSALNativeAuthCodeRequiredState step of a Native Auth V2 flow.

Conform to this protocol (in addition to the terminal callbacks inherited from MSALNativeAuthFlowDelegate) to handle this state. Conforming is opt-in per state, but the callback is required once you conform.

Per-state delegate for the MSALNativeAuthMFARequiredState step of a Native Auth V2 flow.

Conform to this protocol (in addition to the terminal callbacks inherited from MSALNativeAuthFlowDelegate) to handle this state. Conforming is opt-in per state, but the callback is required once you conform.

Per-state delegate for the MSALNativeAuthMFAVerificationRequiredState step of a Native Auth V2 flow.

Conform to this protocol (in addition to the terminal callbacks inherited from MSALNativeAuthFlowDelegate) to handle this state. Conforming is opt-in per state, but the callback is required once you conform.

Per-state delegate for the MSALNativeAuthNewPasswordRequiredState step of a Native Auth V2 flow.

Conform to this protocol (in addition to the terminal callbacks inherited from MSALNativeAuthFlowDelegate) to handle this state. Conforming is opt-in per state, but the callback is required once you conform.

Per-state delegate for the MSALNativeAuthPasswordRequiredState step of a Native Auth V2 flow.

Conform to this protocol (in addition to the terminal callbacks inherited from MSALNativeAuthFlowDelegate) to handle this state. Conforming is opt-in per state, but the callback is required once you conform.

Per-state delegate for the MSALNativeAuthSignInAfterResetPasswordState step of a Native Auth V2 flow.

Conform to this protocol (in addition to the terminal callbacks inherited from MSALNativeAuthFlowDelegate) to handle this state. Conforming is opt-in per state, but the callback is required once you conform.

Per-state delegate for the MSALNativeAuthStrongAuthRegistrationRequiredState step of a Native Auth V2 flow.

Conform to this protocol (in addition to the terminal callbacks inherited from MSALNativeAuthFlowDelegate) to handle this state. Conforming is opt-in per state, but the callback is required once you conform.

Per-state delegate for the MSALNativeAuthStrongAuthVerificationRequiredState step of a Native Auth V2 flow.

Conform to this protocol (in addition to the terminal callbacks inherited from MSALNativeAuthFlowDelegate) to handle this state. Conforming is opt-in per state, but the callback is required once you conform.