HostedUIOptions

public struct HostedUIOptions

The options object for showSignIn API when using Hosted Auth solution like Amazon Cognito UserPools or AUth0.

NOTE: If specified, some of the values in this type will override the corresponding values in awsconfiguration.json. See the init method below.

  • Initializer for hosted UI options.

    Declaration

    Swift

    public init(disableFederation: Bool = false,
                scopes: [String]? = nil,
                identityProvider: String? = nil,
                idpIdentifier: String? = nil,
                federationProviderName: String? = nil,
                signInURIQueryParameters: [String: String]? = nil,
                tokenURIQueryParameters: [String: String]? = nil,
                signOutURIQueryParameters: [String: String]? = nil)

    Parameters

    disableFederation

    If set to true, will not federate with Cognito Identity service to fetch AWSCredentials. true by default.

    scopes

    The scopes for the current login session. If specified here, the scopes specified in awsconfiguration.json would be over-ridden.

    identityProvider

    The IdentityProvider to be used for hosted UI. If using Cognito UserPools it could be Google, Facebook, etc.

    idpIdentifier

    The IdentityProvider identifier if using multiple instances of same identity provider.

    federationProviderName

    If federating with Cognito Identity and using a provider like Auth0 specify the provider name, e.g. .auth0.com.

    signInURIQueryParameters

    The additional query parameters apart from standard OAuth w/ open id connect parameters for signInURI. If specified here, the signInURIQueryParameters specified in awsconfiguration.json would be over-ridden.

    tokenURIQueryParameters

    The additional query parameters apart from standard OAuth w/ open id connect parameters for tokenURI. If specified here, the tokenURIQueryParameters specified in awsconfiguration.json would be over-ridden.

    signOutURIQueryParameters

    The additional query parameters apart from standard OAuth w/ open id connect parameters for signOutURI. If specified here, the signOutURIQueryParameters specified in awsconfiguration.json would be over-ridden.