FirebaseAuth Framework Reference

FIROAuthProvider

A concrete implementation ofAuthProvider for generic OAuth Providers.

  • Array used to configure the OAuth scopes.

    Declaration

    Objective-C

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

  • Dictionary used to configure the OAuth custom parameters.

    Declaration

    Objective-C

    @property(nonatomic,copy,nullable)NSDictionary<NSString*,NSString*>*customParameters;

  • The provider ID indicating the specific OAuth provider this OAuthProvider instance represents.

    Declaration

    Objective-C

    @property(nonatomic,copy,readonly)NSString*_NonnullproviderID;

  • Declaration

    Objective-C

    +(nonnullFIROAuthProvider*)providerWithProviderID:(nonnullNSString*)providerID;

    Parameters

    providerID

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

    Return Value

    An instance ofOAuthProvider corresponding to the specified provider ID.

  • Declaration

    Objective-C

    +(nonnullFIROAuthProvider*)providerWithProviderID:(nonnullNSString*)providerIDauth:(nonnullFIRAuth*)auth;

    Parameters

    providerID

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

    auth

    The auth instance to be associated with theOAuthProvider instance.

    Return Value

    An instance ofOAuthProvider corresponding to the specified provider ID.

  • Creates anAuthCredential for the OAuth 2 provider identified by provider ID, ID token, and access token.

    Declaration

    Objective-C

    +(nonnullFIROAuthCredential*)credentialWithProviderID:(nonnullNSString*)providerIDIDToken:(nonnullNSString*)IDTokenaccessToken:(nullableNSString*)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 access token associated with the Auth credential be created, ifavailable.

    Return Value

    AAuthCredential for the specified provider ID, ID token and access token.

  • Creates anAuthCredential for the OAuth 2 provider identified by provider ID using an ID token.

    Declaration

    Objective-C

    +(nonnullFIROAuthCredential*)credentialWithProviderID:(nonnullNSString*)providerIDaccessToken:(nonnullNSString*)accessToken;

    Parameters

    providerID

    The provider ID associated with the Auth credential being created.

    accessToken

    The access token associated with the Auth credential be created

    Return Value

    AnAuthCredential.

  • Creates anAuthCredential for that OAuth 2 provider identified by provider ID, ID token, raw nonce, and access token.

    Declaration

    Objective-C

    +(nonnullFIROAuthCredential*)credentialWithProviderID:(nonnullNSString*)providerIDIDToken:(nonnullNSString*)IDTokenrawNonce:(nullableNSString*)rawNonceaccessToken:(nullableNSString*)accessToken;

    Parameters

    providerID

    The provider ID associated with the Auth credential being created.

    IDToken

    The IDToken associated with the Auth credential being created.

    rawNonce

    The raw nonce associated with the Auth credential being created.

    accessToken

    The access token associated with the Auth credential be created, ifavailable.

    Return Value

    AAuthCredential for the specified provider ID, ID token and access token.

  • Creates anAuthCredential for that OAuth 2 provider identified by providerID using an ID token and raw nonce.

    Declaration

    Objective-C

    +(nonnullFIROAuthCredential*)credentialWithProviderID:(nonnullNSString*)providerIDIDToken:(nonnullNSString*)IDTokenrawNonce:(nullableNSString*)rawNonce;

    Parameters

    providerID

    The provider ID associated with the Auth credential being created.

    IDToken

    The IDToken associated with the Auth credential being created.

    rawNonce

    The raw nonce associated with the Auth credential being created.

    Return Value

    AAuthCredential.

  • Creates anAuthCredential for the Sign in with Apple OAuth 2 provider identified by ID token, raw nonce, and full name. This method is specific to the Sign in with Apple OAuth 2 provider as this provider requires the full name to be passed explicitly.

    Declaration

    Objective-C

    +(nonnullFIROAuthCredential*)appleCredentialWithIDToken:(nonnullNSString*)IDTokenrawNonce:(nullableNSString*)rawNoncefullName:(nullableNSPersonNameComponents*)fullName;

    Parameters

    IDToken

    The IDToken associated with the Sign in with Apple Auth credential being created.

    rawNonce

    The raw nonce associated with the Sign in with Apple Auth credential beingcreated.

    fullName

    The full name associated with the Sign in with Apple Auth credential beingcreated.

    Return Value

    AnAuthCredential.

  • This class is not meant to be initialized.

    Declaration

    Objective-C

    -(nonnullinstancetype)init;

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2023-03-21 UTC.