Constants

The following constants are available globally.

  • Project version number for MSAL

    Declaration

    Objective-C

    extern double MSAL__Framework_VersionNumber

    Swift

    var MSAL__Framework_VersionNumber: Double

  • Project version string for MSAL

    Declaration

    Objective-C

    extern const unsigned char MSAL__Framework_VersionString[]

    Swift

    let MSAL__Framework_VersionString: <<error type>>

  • Undocumented

    Declaration

    Objective-C

    extern NSString * _Nonnull const MSAL_PRIMARY_REGISTRATION_UPN

    Swift

    let MSAL_PRIMARY_REGISTRATION_UPN: String

  • Undocumented

    Declaration

    Objective-C

    extern NSString * _Nonnull const MSAL_PRIMARY_REGISTRATION_DEVICE_ID

    Swift

    let MSAL_PRIMARY_REGISTRATION_DEVICE_ID: String

  • Undocumented

    Declaration

    Objective-C

    extern NSString * _Nonnull const MSAL_PRIMARY_REGISTRATION_TENANT_ID

    Swift

    let MSAL_PRIMARY_REGISTRATION_TENANT_ID: String

  • Undocumented

    Declaration

    Objective-C

    extern NSString * _Nonnull const MSAL_PRIMARY_REGISTRATION_CLOUD

    Swift

    let MSAL_PRIMARY_REGISTRATION_CLOUD: String

  • Undocumented

    Declaration

    Objective-C

    extern NSString * _Nonnull const MSAL_PRIMARY_REGISTRATION_CERTIFICATE_THUMBPRINT

    Swift

    let MSAL_PRIMARY_REGISTRATION_CERTIFICATE_THUMBPRINT: String

  • The OAuth error returned by the service.

    Declaration

    Objective-C

    extern NSString *MSALOAuthErrorKey

    Swift

    let MSALOAuthErrorKey: String

  • The suberror returned by the service.

    Declaration

    Objective-C

    extern NSString *MSALOAuthSubErrorKey

    Swift

    let MSALOAuthSubErrorKey: String

  • The extended error description. Note that this string can change and should not be relied upon for any error handling logic.

    Declaration

    Objective-C

    extern NSString *MSALErrorDescriptionKey

    Swift

    let MSALErrorDescriptionKey: String

  • Internal error code returned together with MSALErrorInternal error.

    Declaration

    Objective-C

    extern NSString *MSALInternalErrorCodeKey

    Swift

    let MSALInternalErrorCodeKey: String

  • Contains all http headers returned from the http error response

    Declaration

    Objective-C

    extern NSString *MSALHTTPHeadersKey

    Swift

    let MSALHTTPHeadersKey: String

  • Correlation ID used for the request

    Declaration

    Objective-C

    extern NSString *MSALCorrelationIDKey

    Swift

    let MSALCorrelationIDKey: String

  • Specifies http response code for error cases

    Declaration

    Objective-C

    extern NSString *MSALHTTPResponseCodeKey

    Swift

    let MSALHTTPResponseCodeKey: String

  • List of scopes that were requested from MSAL, but not granted in the response.

    This can happen in multiple cases:

    • Requested scope is not supported
    • Requested scope is not Recognized (According to OIDC, any scope values used that are not understood by an implementation SHOULD be ignored.)
    • Requested scope is not supported for a particular account (Organizational scopes when it is a consumer account)

    Declaration

    Objective-C

    extern NSString *MSALDeclinedScopesKey

    Swift

    let MSALDeclinedScopesKey: String

  • Displayable user id for the particular error if available

    Declaration

    Objective-C

    extern NSString *MSALDisplayableUserIdKey

    Swift

    let MSALDisplayableUserIdKey: String

  • List of granted scopes in case some scopes weren’t granted (see MSALDeclinedScopesKey for more info)

    Declaration

    Objective-C

    extern NSString *MSALGrantedScopesKey

    Swift

    let MSALGrantedScopesKey: String

  • If server returned tokens successfully, but response data doesn’t pass validation, MSAL will return an error and original result in the error userInfo

    Declaration

    Objective-C

    extern NSString *MSALInvalidResultKey

    Swift

    let MSALInvalidResultKey: String

  • Broker version that was used for the authentication

    Declaration

    Objective-C

    extern NSString *MSALBrokerVersionKey

    Swift

    let MSALBrokerVersionKey: String

  • Home account id for the particular error if available

    Declaration

    Objective-C

    extern NSString *MSALHomeAccountIdKey

    Swift

    let MSALHomeAccountIdKey: String

  • Error domain that MSAL uses for authentication related errors.

    Declaration

    Objective-C

    extern NSString *MSALErrorDomain

    Swift

    let MSALErrorDomain: String

  • Fired at the start of a resource load in the webview. The URL of the load, if available, will be in the @“url” key in the userInfo dictionary

    Declaration

    Objective-C

    extern NSString *MSALWebAuthDidStartLoadNotification

    Swift

    static let MSALWebAuthDidStartLoad: NSNotification.Name

  • Fired when a resource finishes loading in the webview.

    Declaration

    Objective-C

    extern NSString *MSALWebAuthDidFinishLoadNotification

    Swift

    static let MSALWebAuthDidFinishLoad: NSNotification.Name

  • Fired when web authentication fails due to reasons originating from the network. Look at the @“error” key in the userInfo dictionary for more details.

    Declaration

    Objective-C

    extern NSString *MSALWebAuthDidFailNotification

    Swift

    static let MSALWebAuthDidFail: NSNotification.Name

  • Fired when authentication finishes

    Declaration

    Objective-C

    extern NSString *MSALWebAuthDidCompleteNotification

    Swift

    static let MSALWebAuthDidComplete: NSNotification.Name

  • Fired before MSAL invokes the broker app

    Declaration

    Objective-C

    extern NSString *MSALWebAuthWillSwitchToBrokerApp

    Swift

    let MSALWebAuthWillSwitchToBrokerApp: String

  • Fired when the application receives a response from the broker. Look at the @“response” key in the userInfo dictionary for the broker response

    Declaration

    Objective-C

    extern NSString *MSALWebAuthDidReceiveResponseFromBroker

    Swift

    let MSALWebAuthDidReceiveResponseFromBroker: String