Method: getProjects

Gets a project's public Identity Toolkit configuration. (Legacy) This method also supports authenticated calls from a developer to retrieve non-public configuration.

HTTP request

GET https://identitytoolkit.googleapis.com/v1/projects

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
delegatedProjectNumber

string (int64 format)

Project Number of the delegated project request. This field should only be used as part of the Firebase V1 migration.
projectNumber

string (int64 format)

Project number of the configuration to retrieve. This field is deprecated and should not be used by new integrations.
androidPackageName

string

Android package name to check against the real android package name. If this field is provided, and sha1_cert_hash is not provided, the action will throw an error if this does not match the real android package name.
iosBundleId

string

iOS bundle id to check against the real ios bundle id. If this field is provided, the action will throw an error if this does not match the real iOS bundle id.
clientId

string

The RP OAuth client ID. If set, a check will be performed to ensure that the OAuth client is valid for the retrieved project and the request rejected with a client error if not valid.
sha1Cert

string

SHA-1 Android application cert hash. If set, a check will be performed to ensure that the cert hash is valid for the retrieved project and androidPackageName.
firebaseAppId

string

The Firebase app ID, for applications that use Firebase. This can be found in the Firebase console for your project. If set, a check will be performed to ensure that the app ID is valid for the retrieved project. If not valid, the request will be rejected with a client error.

Request body

The request body must be empty.

Response body

Response message for v1.getProjects.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "projectId": string,
  "apiKey": string,
  "allowPasswordUser": boolean,
  "idpConfig": [
    {
      object (IdpConfig)
    }
  ],
  "authorizedDomains": [
    string
  ],
  "enableAnonymousUser": boolean,
  "dynamicLinksDomain": string,
  "useEmailSending": boolean,
  "resetPasswordTemplate": {
    object (EmailTemplate)
  },
  "verifyEmailTemplate": {
    object (EmailTemplate)
  },
  "changeEmailTemplate": {
    object (EmailTemplate)
  },
  "legacyResetPasswordTemplate": {
    object (EmailTemplate)
  },
  "revertSecondFactorAdditionTemplate": {
    object (EmailTemplate)
  }
}
Fields
projectId

string

The project id of the retrieved configuration.
apiKey

string

Google Cloud API key. This field is only returned for authenticated calls from a developer.
allowPasswordUser

boolean

Whether to allow password account sign up. This field is only returned for authenticated calls from a developer.
idpConfig[]

object (IdpConfig)

OAuth2 provider config. This field is only returned for authenticated calls from a developer.
authorizedDomains[]

string

Authorized domains for widget redirect.
enableAnonymousUser

boolean

Whether anonymous user is enabled. This field is only returned for authenticated calls from a developer.
useEmailSending

boolean

Whether to use email sending. This field is only returned for authenticated calls from a developer.
resetPasswordTemplate

object (EmailTemplate)

Email template for reset password. This field is only returned for authenticated calls from a developer.
verifyEmailTemplate

object (EmailTemplate)

Email template for verify email. This field is only returned for authenticated calls from a developer.
changeEmailTemplate

object (EmailTemplate)

Email template for change email. This field is only returned for authenticated calls from a developer.
legacyResetPasswordTemplate

object (EmailTemplate)

Reset password email template for legacy Firebase V1 app. This field is only returned for authenticated calls from a developer.
revertSecondFactorAdditionTemplate

object (EmailTemplate)

Email template for reverting second factor additions. This field is only returned for authenticated calls from a developer.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IdpConfig

Config of an identity provider.

JSON representation 
{
  "provider": enum (Provider),
  "enabled": boolean,
  "experimentPercent": integer,
  "clientId": string,
  "secret": string,
  "whitelistedAudiences": [
    string
  ]
}
Fields
provider

enum (Provider)

Name of the identity provider.
enabled

boolean

True if allows the user to sign in with the provider.
experimentPercent

integer

Percent of users who will be prompted/redirected federated login for this IdP
clientId

string

OAuth2 client ID.
secret

string

OAuth2 client secret.
whitelistedAudiences[]

string

Whitelisted client IDs for audience check.

Provider

Name of the identity provider.

Enums
PROVIDER_UNSPECIFIED
MSLIVE Microsoft Live as identity provider.
GOOGLE Google as identity provider.
FACEBOOK Facebook as identity provider.
PAYPAL PayPal as identity provider.
TWITTER Twitter as identity provider.
YAHOO Yahoo as identity provider.
AOL AOL as identity provider.
GITHUB GitHub as identity provider.
GOOGLE_PLAY_GAMES Google Play Games as identity provider.
LINKEDIN LinkedIn as identity provider.
IOS_GAME_CENTER iOS Game Center as identity provider.

EmailTemplate

Email template

JSON representation 
{
  "disabled": boolean,
  "from": string,
  "body": string,
  "subject": string,
  "fromDisplayName": string,
  "format": enum (EmailBodyFormat),
  "replyTo": string,
  "fromLocalPart": string,
  "locale": string,
  "customized": boolean
}
Fields
disabled

boolean

Whether the template is disabled. If true, a default template will be used.
from

string

From address of the email
body

string

Email body
subject

string

Subject of the email
fromDisplayName

string

From display name
format

enum (EmailBodyFormat)

Email body format
replyTo

string

Reply-to address
fromLocalPart

string

Local part of From address
locale

string

Value is in III language code format (e.g. "zh-CN", "es"). Both '-' and '_' separators are accepted.
customized

boolean

Whether the body or subject of the email is customized.

EmailBodyFormat

Email body format

Enums
EMAIL_BODY_FORMAT_UNSPECIFIED Default value. Do not use.
PLAINTEXT Email body is in plain text format.
HTML Email body is in HTML format.