SFSDKAuthPreferences Class Reference

Inherits from NSObject
Declared in SFSDKAuthPreferences.h

  additionalOAuthParameterKeys

An array of additional keys (NSString) to parse during OAuth

@property (nonatomic, strong) NSArray *additionalOAuthParameterKeys

Declared In

SFSDKAuthPreferences.h

  additionalTokenRefreshParams

A dictionary of additional parameters (key value pairs) to send during token refresh

@property (nonatomic, strong) NSDictionary *additionalTokenRefreshParams

Declared In

SFSDKAuthPreferences.h

  loginHost

The host that will be used for login.

@property (nonatomic, strong, nullable) NSString *loginHost

Declared In

SFSDKAuthPreferences.h

  retryLoginAfterFailure

Should the login process start again if it fails (default: YES)

@property (nonatomic, assign) BOOL retryLoginAfterFailure

Declared In

SFSDKAuthPreferences.h

  oauthClientId

OAuth client ID to use for login. Apps may customize by setting this property before login; otherwise, this value is determined by the SFDCOAuthClientIdPreference configured via the settings bundle.

@property (nonatomic, copy, nullable) NSString *oauthClientId

Declared In

SFSDKAuthPreferences.h

  oauthCompletionUrl

OAuth callback url to use for the OAuth login process. Apps may customize this by setting this property before login. By default this value is picked up from the main bundle property SFDCOAuthRedirectUri

@property (nonatomic, copy, nullable) NSString *oauthCompletionUrl

Declared In

SFSDKAuthPreferences.h

  brandLoginPath

The Branded Login path configured for this application.

@property (nonatomic, copy, nullable) NSString *brandLoginPath

Declared In

SFSDKAuthPreferences.h

  scopes

The OAuth scopes associated with the app.

@property (nonatomic, copy) NSSet<NSString*> *scopes

Declared In

SFSDKAuthPreferences.h

  isIdentityProvider

Use this property to enable an app to become and IdentityProvider for other apps

@property (nonatomic, assign) BOOL isIdentityProvider

Declared In

SFSDKAuthPreferences.h

  idpEnabled

Check if the idp apps URI scheme has been set.

@property (nonatomic, assign, readonly) BOOL idpEnabled

Declared In

SFSDKAuthPreferences.h

  idpAppURIScheme

Use this property to indicate the url scheme for the Identity Provider app

@property (nonatomic, copy, nullable) NSString *idpAppURIScheme

Declared In

SFSDKAuthPreferences.h

  appDisplayName

A user friendly display name for use in UI by the SDK on behalf of the app. This value will be used on various authentication screens such as biometric enrollment or IDP login. If left unset, this property will fallback to CFBundleDisplayName or CFBundleName depending on what is available.

@property (nonatomic, copy) NSString *appDisplayName

Discussion

This name will be displayed in the user selection view of the identity provider app.

Declared In

SFSDKAuthPreferences.h

  requireBrowserAuthentication

Whether the app is configured to require certificate-based authentication. (RequireCertAuth)

@property (nonatomic, assign) BOOL requireBrowserAuthentication

Declared In

SFSDKAuthPreferences.h