Method: getProjects

Ruft die öffentliche Identity Toolkit-Konfiguration eines Projekts ab. (Alt) Diese Methode unterstützt auch authentifizierte Aufrufe von Entwicklern zum Abrufen nicht öffentlicher Konfigurationen.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
delegatedProjectNumber

string (int64 format)

Projektnummer der delegierten Projektanfrage. Dieses Feld sollte nur im Rahmen der Firebase V1-Migration verwendet werden.
projectNumber

string (int64 format)

Projektnummer der abzurufenden Konfiguration. Dieses Feld wurde eingestellt und sollte bei neuen Integrationen nicht verwendet werden.
androidPackageName

string

Android-Paketname, der mit dem tatsächlichen Android-Paketnamen verglichen werden soll. Wenn dieses Feld angegeben ist und sha1_cert_hash nicht angegeben ist, wird bei der Aktion ein Fehler ausgegeben, wenn der Wert nicht mit dem tatsächlichen Namen des Android-Pakets übereinstimmt.
iosBundleId

string

iOS-Bundle-ID, die mit der tatsächlichen iOS-Bundle-ID abgeglichen werden soll. Wenn dieses Feld angegeben ist, wird bei der Aktion ein Fehler ausgegeben, wenn die angegebene ID nicht mit der tatsächlichen iOS-Bundle-ID übereinstimmt.
clientId

string

Die OAuth-Client-ID des RP. Wenn diese Option festgelegt ist, wird geprüft, ob der OAuth-Client für das abgerufene Projekt gültig ist. Andernfalls wird die Anfrage mit einem Clientfehler abgelehnt.
sha1Cert

string

SHA-1-Hash des Android-Anwendungszertifikats. Wenn diese Option festgelegt ist, wird geprüft, ob der Zertifikat-Hash für das abgerufene Projekt und den androidPackageName gültig ist.
firebaseAppId

string

Die Firebase App-ID für Anwendungen, die Firebase verwenden. Sie finden sie in der Firebase Console für Ihr Projekt. Wenn diese Option festgelegt ist, wird geprüft, ob die App-ID für das abgerufene Projekt gültig ist. Ist der Schlüssel ungültig, wird die Anfrage mit einem Clientfehler abgelehnt.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für v1.getProjects

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "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)
  }
}
Felder
projectId

string

Die Projekt-ID der abgerufenen Konfiguration.
apiKey

string

Google Cloud API-Schlüssel. Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.
allowPasswordUser

boolean

Ob die Registrierung von Passwörtern für Konten zulässig ist. Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.
idpConfig[]

object (IdpConfig)

OAuth2-Anbieterkonfiguration Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.
authorizedDomains[]

string

Autorisierte Domains für die Weiterleitung des Widgets.
enableAnonymousUser

boolean

Gibt an, ob der anonyme Nutzer aktiviert ist. Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.
useEmailSending

boolean

Ob E-Mails gesendet werden sollen. Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.
resetPasswordTemplate

object (EmailTemplate)

E-Mail-Vorlage zum Zurücksetzen des Passworts Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.
verifyEmailTemplate

object (EmailTemplate)

E-Mail-Vorlage für die Bestätigung der E-Mail-Adresse. Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.
changeEmailTemplate

object (EmailTemplate)

E-Mail-Vorlage für die Änderung der E-Mail-Adresse. Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.
legacyResetPasswordTemplate

object (EmailTemplate)

Vorlage für E-Mails zum Zurücksetzen des Passworts für die alte Firebase V1-App. Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.
revertSecondFactorAdditionTemplate

object (EmailTemplate)

E-Mail-Vorlage zum Rückgängigmachen der Hinzufügung eines zweiten Faktors Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IdpConfig

Konfiguration eines Identitätsanbieters.

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

enum (Provider)
enabled

boolean

„Wahr“, wenn der Nutzer sich beim Anbieter anmelden kann.
experimentPercent

integer

Prozentsatz der Nutzer, die für diesen IdP zur föderierten Anmeldung aufgefordert oder weitergeleitet werden
clientId

string

OAuth2-Client-ID.
secret

string

OAuth2-Clientschlüssel
whitelistedAudiences[]

string

Client-IDs auf der Zulassungsliste für die Zielgruppenprüfung.

Anbieter

Name des Identitätsanbieters.

Enums
PROVIDER_UNSPECIFIED
MSLIVE Microsoft Live als Identitätsanbieter
GOOGLE Google als Identitätsanbieter
FACEBOOK Facebook als Identitätsanbieter
PAYPAL PayPal als Identitätsanbieter
TWITTER Twitter als Identitätsanbieter
YAHOO Yahoo als Identitätsanbieter
AOL AOL als Identitätsanbieter
GITHUB GitHub als Identitätsanbieter
GOOGLE_PLAY_GAMES Google Play Spiele als Identitätsanbieter
LINKEDIN LinkedIn als Identitätsanbieter
IOS_GAME_CENTER iOS Game Center als Identitätsanbieter

EmailTemplate

E-Mail-Vorlage

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

boolean

Gibt an, ob die Vorlage deaktiviert ist. Wenn „wahr“ festgelegt ist, wird eine Standardvorlage verwendet.
from

string

Absenderadresse der E-Mail
body

string

E-Mail-Text
subject

string

Betreff der E-Mail
fromDisplayName

string

Über den Anzeigenamen
format

enum (EmailBodyFormat)

Format des E-Mail-Texts
replyTo

string

Antwortadresse
fromLocalPart

string

Lokaler Teil der Absenderadresse
locale

string

Der Wert ist im Format eines Sprachcodes der III. Welt (z. B. „de-DE“ oder „es“). Sowohl Bindestrich als auch Unterstrich sind zulässig.
customized

boolean

Ob der Text oder Betreff der E-Mail angepasst ist.

EmailBodyFormat

Format des E-Mail-Texts

Enums
EMAIL_BODY_FORMAT_UNSPECIFIED Standardwert. Nicht verwenden.
PLAINTEXT Der E-Mail-Text ist im Nur-Text-Format.
HTML Der E-Mail-Text ist im HTML-Format.