FIROAuthProvider


@interface FIROAuthProvider : NSObject <FIRFederatedAuthProvider>

A concrete implementation of FIRAuthProvider for generic OAuth Providers.

  • Array used to configure the OAuth scopes.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSArray<NSString *> *scopes;
  • Dictionary used to configure the OAuth custom parameters.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable)
        NSDictionary<NSString *, NSString *> *customParameters;
  • The provider ID indicating the specific OAuth provider this OAuthProvider instance represents.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic) NSString *_Nonnull providerID;
  • Declaration

    Objective-C

    + (nonnull FIROAuthProvider *)providerWithProviderID:
        (nonnull NSString *)providerID;

    Parameters

    providerID

    The provider ID of the IDP for which this auth provider instance will be configured.

    Return Value

    An instance of FIROAuthProvider corresponding to the specified provider ID.

  • Declaration

    Objective-C

    + (nonnull FIROAuthProvider *)providerWithProviderID:
                                      (nonnull NSString *)providerID
                                                    auth:(nonnull FIRAuth *)auth;

    Parameters

    providerID

    The provider ID of the IDP for which this auth provider instance will be configured.

    auth

    The auth instance to be associated with the FIROAuthProvider instance.

    Return Value

    An instance of FIROAuthProvider corresponding to the specified provider ID.

  • Creates an FIRAuthCredential for that OAuth 2 provider identified by providerID, ID token and access token.

    Declaration

    Objective-C

    + (nonnull FIROAuthCredential *)
    credentialWithProviderID:(nonnull NSString *)providerID
                     IDToken:(nonnull NSString *)IDToken
                 accessToken:(nullable NSString *)accessToken
                pendingToken:(nullable NSString *)pendingToken;

    Parameters

    providerID

    The provider ID associated with the Auth credential being created.

    IDToken

    The IDToken associated with the Auth credential being created.

    accessToken

    The accessstoken associated with the Auth credential be created, if available.

    pendingToken

    The pending token used when completing the headful-lite flow.

    Return Value

    A FIRAuthCredential for the specified provider ID, ID token and access token.

  • Creates an FIRAuthCredential for that OAuth 2 provider identified by providerID, ID token and access token.

    Declaration

    Objective-C

    + (nonnull FIROAuthCredential *)
    credentialWithProviderID:(nonnull NSString *)providerID
                     IDToken:(nonnull NSString *)IDToken
                 accessToken:(nullable NSString *)accessToken;

    Parameters

    providerID

    The provider ID associated with the Auth credential being created.

    IDToken

    The IDToken associated with the Auth credential being created.

    accessToken

    The accessstoken associated with the Auth credential be created, if available.

    Return Value

    A FIRAuthCredential for the specified provider ID, ID token and access token.

  • Creates an FIRAuthCredential for that OAuth 2 provider identified by providerID using an ID token.

    Declaration

    Objective-C

    + (nonnull FIROAuthCredential *)
    credentialWithProviderID:(nonnull NSString *)providerID
                 accessToken:(nonnull NSString *)accessToken;

    Parameters

    providerID

    The provider ID associated with the Auth credential being created.

    accessToken

    The accessstoken associated with the Auth credential be created

    Return Value

    A FIRAuthCredential.

  • This class is not meant to be initialized.

    Declaration

    Objective-C

    - (nonnull instancetype)init;