Method: getProjects

Récupère la configuration publique Identity Toolkit d'un projet. (Ancienne) Cette méthode permet également aux développeurs d'effectuer des appels authentifiés pour récupérer une configuration non publique.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
delegatedProjectNumber

string (int64 format)

Numéro du projet de la demande de projet déléguée. Ce champ ne doit être utilisé que dans le cadre de la migration Firebase V1.

projectNumber

string (int64 format)

Numéro de projet de la configuration à récupérer. Ce champ est obsolète et ne doit pas être utilisé par les nouvelles intégrations.

androidPackageName

string

Nom du package Android à comparer au nom réel du package Android. Si ce champ est fourni et que sha1_cert_hash ne l'est pas, l'action génère une erreur si le nom ne correspond pas au nom réel du package Android.

iosBundleId

string

ID du bundle iOS à comparer à l'ID du bundle iOS réel. Si ce champ est fourni, l'action génère une erreur si l'ID de bundle iOS réel ne correspond pas.

clientId

string

ID client OAuth de la RP. Si cette valeur est définie, une vérification est effectuée pour s'assurer que le client OAuth est valide pour le projet récupéré et la requête est refusée avec une erreur client si elle ne l'est pas.

sha1Cert

string

Hachage SHA-1 du certificat d'application Android. Si cette valeur est définie, une vérification est effectuée pour s'assurer que le hachage du certificat est valide pour le projet et androidPackageName récupérés.

firebaseAppId

string

ID de l'application Firebase, pour les applications qui utilisent Firebase. Vous le trouverez dans la console Firebase de votre projet. Si cette valeur est définie, une vérification est effectuée pour s'assurer que l'ID de l'application est valide pour le projet récupéré. Si ce n'est pas le cas, la requête sera rejetée avec une erreur client.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour v1.getProjects.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "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)
  }
}
Champs
projectId

string

ID du projet de la configuration récupérée.

apiKey

string

Clé API Google Cloud Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

allowPasswordUser

boolean

Indique si l'inscription à un compte avec mot de passe est autorisée. Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

idpConfig[]

object (IdpConfig)

Configuration du fournisseur OAuth2. Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

authorizedDomains[]

string

Domaines autorisés pour la redirection de widget.

enableAnonymousUser

boolean

Indique si l'utilisateur anonyme est activé. Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

useEmailSending

boolean

Indique si l'envoi d'e-mails doit être utilisé. Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

resetPasswordTemplate

object (EmailTemplate)

Modèle d'e-mail de réinitialisation de mot de passe. Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

verifyEmailTemplate

object (EmailTemplate)

Modèle d'e-mail pour la validation de l'adresse e-mail. Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

changeEmailTemplate

object (EmailTemplate)

Modèle d'e-mail pour modifier l'adresse e-mail. Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

legacyResetPasswordTemplate

object (EmailTemplate)

Modèle d'e-mail de réinitialisation du mot de passe pour l'ancienne application Firebase V1. Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

revertSecondFactorAdditionTemplate

object (EmailTemplate)

Modèle d'e-mail pour annuler l'ajout d'un second facteur Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez Authentication Overview.

IdpConfig

Configuration d'un fournisseur d'identité.

Représentation JSON
{
  "provider": enum (Provider),
  "enabled": boolean,
  "experimentPercent": integer,
  "clientId": string,
  "secret": string,
  "whitelistedAudiences": [
    string
  ]
}
Champs
provider

enum (Provider)

enabled

boolean

"True" si l'utilisateur peut se connecter avec le fournisseur.

experimentPercent

integer

Pourcentage d'utilisateurs qui seront invités/redirigés vers la connexion fédérée pour ce fournisseur d'identité

clientId

string

ID client OAuth2.

secret

string

Code secret du client OAuth2.

whitelistedAudiences[]

string

ID client ajoutés à la liste blanche pour la vérification des audiences.

Fournisseur

Nom du fournisseur d'identité.

Enums
PROVIDER_UNSPECIFIED
MSLIVE Microsoft Live en tant que fournisseur d'identité.
GOOGLE Google en tant que fournisseur d'identité
FACEBOOK Facebook en tant que fournisseur d'identité
PAYPAL PayPal en tant que fournisseur d'identité
TWITTER Twitter en tant que fournisseur d'identité
YAHOO Yahoo en tant que fournisseur d'identité.
AOL AOL en tant que fournisseur d'identité.
GITHUB GitHub en tant que fournisseur d'identité
GOOGLE_PLAY_GAMES Google Play Jeux en tant que fournisseur d'identité.
LINKEDIN LinkedIn en tant que fournisseur d'identité
IOS_GAME_CENTER iOS Game Center en tant que fournisseur d'identité

EmailTemplate

Modèle d'e-mail

Représentation JSON
{
  "disabled": boolean,
  "from": string,
  "body": string,
  "subject": string,
  "fromDisplayName": string,
  "format": enum (EmailBodyFormat),
  "replyTo": string,
  "fromLocalPart": string,
  "locale": string,
  "customized": boolean
}
Champs
disabled

boolean

Indique si le modèle est désactivé. Si cette valeur est définie sur "true", un modèle par défaut est utilisé.

from

string

Adresse de l'expéditeur de l'e-mail

body

string

Corps de l'e-mail

subject

string

Objet de l'e-mail

fromDisplayName

string

À partir du nom à afficher

format

enum (EmailBodyFormat)

Format du corps de l'e-mail

replyTo

string

Adresse de réponse

fromLocalPart

string

Partie locale de l'adresse de l'expéditeur

locale

string

La valeur est au format de code de langue III (par exemple, "zh-CN", "es"). Les séparateurs "-" et "_" sont acceptés.

customized

boolean

Indique si le corps ou l'objet de l'e-mail est personnalisé.

EmailBodyFormat

Format du corps de l'e-mail

Enums
EMAIL_BODY_FORMAT_UNSPECIFIED Valeur par défaut. Ne l'utilisez pas.
PLAINTEXT Le corps de l'e-mail est au format texte brut.
HTML Le corps de l'e-mail est au format HTML.