Method: getProjects

Obtiene la configuración pública de Identity Toolkit de un proyecto. (heredado) Este método también admite llamadas autenticadas de un desarrollador para recuperar la configuración no pública.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
delegatedProjectNumber

string (int64 format)

Es el número de proyecto de la solicitud de proyecto delegada. Este campo solo debe usarse como parte de la migración de Firebase V1.

projectNumber

string (int64 format)

Es el número de proyecto de la configuración que se desea recuperar. Este campo está obsoleto y las integraciones nuevas no deben usarlo.

androidPackageName

string

Es el nombre del paquete de Android que se debe comparar con el nombre real del paquete de Android. Si se proporciona este campo y no se proporciona sha1_cert_hash, la acción arrojará un error si no coincide con el nombre real del paquete de Android.

iosBundleId

string

Es el ID del paquete de iOS que se compara con el ID del paquete de iOS real. Si se proporciona este campo, la acción arrojará un error si no coincide con el ID de paquete real de iOS.

clientId

string

El ID de cliente de OAuth del RP Si se establece, se realizará una verificación para garantizar que el cliente de OAuth sea válido para el proyecto recuperado y que se rechace la solicitud con un error de cliente si no es válido.

sha1Cert

string

Hash de certificado de aplicación de Android SHA-1 Si se establece, se realizará una verificación para garantizar que el hash de la certificación sea válido para el proyecto recuperado y androidPackageName.

firebaseAppId

string

El ID de app de Firebase, para las aplicaciones que usan Firebase Puedes encontrar esta información en Firebase console de tu proyecto. Si se establece, se realizará una verificación para garantizar que el ID de la app sea válido para el proyecto recuperado. Si no es válido, la solicitud se rechazará con un error del cliente.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para v1.getProjects.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación 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)
  }
}
Campos
projectId

string

El ID del proyecto de la configuración recuperada.

apiKey

string

Clave de la API de Google Cloud. Este campo solo se muestra para las llamadas autenticadas de un desarrollador.

allowPasswordUser

boolean

Indica si se permite el registro de cuentas con contraseña. Este campo solo se muestra para las llamadas autenticadas de un desarrollador.

idpConfig[]

object (IdpConfig)

Configuración del proveedor de OAuth2 Este campo solo se muestra para las llamadas autenticadas de un desarrollador.

authorizedDomains[]

string

Dominios autorizados para el redireccionamiento de widgets.

enableAnonymousUser

boolean

Indica si el usuario anónimo está habilitado. Este campo solo se muestra para las llamadas autenticadas de un desarrollador.

useEmailSending

boolean

Si se debe usar el envío de correos electrónicos. Este campo solo se muestra para las llamadas autenticadas de un desarrollador.

resetPasswordTemplate

object (EmailTemplate)

Plantilla de correo electrónico para restablecer la contraseña Este campo solo se muestra para las llamadas autenticadas de un desarrollador.

verifyEmailTemplate

object (EmailTemplate)

Plantilla de correo electrónico para verificar el correo electrónico. Este campo solo se muestra para las llamadas autenticadas de un desarrollador.

changeEmailTemplate

object (EmailTemplate)

Plantilla de correo electrónico para cambiar el correo electrónico. Este campo solo se muestra para las llamadas autenticadas de un desarrollador.

legacyResetPasswordTemplate

object (EmailTemplate)

Es la plantilla de correo electrónico para restablecer la contraseña de la app heredada de Firebase V1. Este campo solo se muestra para las llamadas autenticadas de un desarrollador.

revertSecondFactorAdditionTemplate

object (EmailTemplate)

Plantilla de correo electrónico para revertir la adición de un segundo factor Este campo solo se muestra para las llamadas autenticadas de un desarrollador.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

IdpConfig

Configuración de un proveedor de identidad

Representación JSON
{
  "provider": enum (Provider),
  "enabled": boolean,
  "experimentPercent": integer,
  "clientId": string,
  "secret": string,
  "whitelistedAudiences": [
    string
  ]
}
Campos
provider

enum (Provider)

enabled

boolean

Es verdadero si permite que el usuario acceda con el proveedor.

experimentPercent

integer

Porcentaje de usuarios a los que se les solicitará o redireccionará el acceso federado para este IdP

clientId

string

ID de cliente de OAuth2.

secret

string

Secreto de cliente de OAuth2

whitelistedAudiences[]

string

IDs de cliente incluidos en la lista de entidades permitidas para la verificación de público

Proveedor

Es el nombre del proveedor de identidad.

Enums
PROVIDER_UNSPECIFIED
MSLIVE Microsoft Live como proveedor de identidad
GOOGLE Google como proveedor de identidad
FACEBOOK Facebook como proveedor de identidad
PAYPAL PayPal como proveedor de identidad
TWITTER Twitter como proveedor de identidad
YAHOO Yahoo como proveedor de identidad
AOL AOL como proveedor de identidad
GITHUB GitHub como proveedor de identidad
GOOGLE_PLAY_GAMES Google Play Juegos como proveedor de identidad
LINKEDIN LinkedIn como proveedor de identidad
IOS_GAME_CENTER Game Center de iOS como proveedor de identidad

EmailTemplate

Plantilla de correo electrónico

Representación JSON
{
  "disabled": boolean,
  "from": string,
  "body": string,
  "subject": string,
  "fromDisplayName": string,
  "format": enum (EmailBodyFormat),
  "replyTo": string,
  "fromLocalPart": string,
  "locale": string,
  "customized": boolean
}
Campos
disabled

boolean

Indica si la plantilla está inhabilitada. Si es verdadero, se usará una plantilla predeterminada.

from

string

Dirección de origen del correo electrónico

body

string

Cuerpo del correo electrónico

subject

string

Asunto del correo electrónico

fromDisplayName

string

Desde el nombre visible

format

enum (EmailBodyFormat)

Formato del cuerpo del correo electrónico

replyTo

string

Dirección de respuesta

fromLocalPart

string

Parte local de la dirección de origen

locale

string

El valor está en formato de código de idioma III (p.ej., "zh-CN", "es"). Se aceptan los separadores "-" y "_".

customized

boolean

Indica si el cuerpo o el asunto del correo electrónico están personalizados.

EmailBodyFormat

Formato del cuerpo del correo electrónico

Enums
EMAIL_BODY_FORMAT_UNSPECIFIED Valor predeterminado No se debe usar.
PLAINTEXT El cuerpo del correo electrónico está en formato de texto sin formato.
HTML El cuerpo del correo electrónico está en formato HTML.