MSALInteractiveTokenParameters

Objective-C

@interface MSALInteractiveTokenParameters : MSALTokenParameters

Swift

class MSALInteractiveTokenParameters : MSALTokenParameters

Token parameters to be used when MSAL is getting a token interactively.

Configuring MSALInteractiveTokenParameters

  • A specific prompt type for the interactive authentication flow.

    Declaration

    Objective-C

    @property (nonatomic) MSALPromptType promptType;

    Swift

    var promptType: Int32 { get set }

  • A loginHint (usually an email) to pass to the service at the beginning of the interactive authentication flow. The account returned in the completion block is not guaranteed to match the loginHint.

    Declaration

    Objective-C

    @property (nonatomic, nullable) NSString *loginHint;

    Swift

    var loginHint: String? { get set }

  • Permissions you want the account to consent to in the same authentication flow, but won’t be included in the returned access token.

    Declaration

    Objective-C

    @property (nonatomic, nullable) NSArray<NSString *> *extraScopesToConsent;

    Swift

    var extraScopesToConsent: [String]? { get set }

  • A copy of the configuration which was provided in the initializer.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) MSALWebviewParameters *_Nonnull webviewParameters;

    Swift

    @NSCopying var webviewParameters: MSALWebviewParameters { get }

  • Deprecated

    Create MSALWebviewParameters and provide it to -initWithScopes:webviewParameters: instead

    The view controller to present from. If nil, the current topmost view controller will be used.

    Declaration

    Objective-C

    @property (nonatomic, weak, nullable) UIViewController *parentViewController;

  • Deprecated

    Create MSALWebviewParameters and provide it to -initWithScopes:webviewParameters: instead

    Modal presentation style for displaying authentication web content.

    Declaration

    Objective-C

    @property (nonatomic) UIModalPresentationStyle presentationStyle;

    Swift

    var presentationStyle: Int32 { get set }

  • Deprecated

    Create MSALWebviewParameters and provide it to -initWithScopes:webviewParameters: instead

    A specific webView type for the interactive authentication flow. By default, it will be set to MSALGlobalConfig.defaultWebviewType.

    Declaration

    Objective-C

    @property (nonatomic) MSALWebviewType webviewType;

    Swift

    var webviewType: Int32 { get set }

  • Deprecated

    Create MSALWebviewParameters and provide it to -initWithScopes:webviewParameters: instead

    For a webviewType MSALWebviewTypeWKWebView, custom WKWebView can be passed on. Web content will be rendered onto this view. Observe strings declared in MSALPublicClientStatusNotifications to know when to dismiss.

    Declaration

    Objective-C

    @property (nonatomic, nullable) WKWebView *customWebview;

    Swift

    var customWebview: WKWebView? { get set }

  • The pre-defined preferred auth method for the interactive request. By default, it will be set to MSALPreferredAuthMethod.MSALPreferredAuthMethodNone.

    Declaration

    Objective-C

    @property (nonatomic) MSALPreferredAuthMethod preferredAuthMethod;

    Swift

    var preferredAuthMethod: Int32 { get set }

Constructing MSALInteractiveTokenParameters

  • Deprecated

    Use -initWithScopes:webviewParameters: instead

    Initializes MSALInteractiveTokenParameters with scopes.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithScopes:(nonnull NSArray<NSString *> *)scopes;

    Swift

    convenience init(scopes: [String])

    Parameters

    scopes

    Permissions you want included in the access token received in the result in the completionBlock. Not all scopes are guaranteed to be included in the access token returned.

  • Initialize MSALInteractiveTokenParameters with scopes and web parameters.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithScopes:(nonnull NSArray<NSString *> *)scopes
                     webviewParameters:
                         (nonnull MSALWebviewParameters *)webviewParameters;

    Swift

    init(scopes: [String], webviewParameters: MSALWebviewParameters)

    Parameters

    scopes

    Permissions you want included in the access token received in the result in the completionBlock. Not all scopes are guaranteed to be included in the access token returned.
    webviewParameters

    User Interface configuration that MSAL uses when getting a token interactively or authorizing an end user.