Method: getProjects

Recebe a configuração pública do Identity Toolkit de um projeto. (Legado) Esse método também oferece suporte a chamadas autenticadas de um desenvolvedor para recuperar a configuração não pública.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
delegatedProjectNumber

string (int64 format)

Número do projeto da solicitação de projeto delegada. Esse campo só deve ser usado como parte da migração do Firebase V1.

projectNumber

string (int64 format)

Número do projeto da configuração a ser recuperada. Este campo foi descontinuado e não deve ser usado por novas integrações.

androidPackageName

string

Nome do pacote Android a ser verificado com o nome real do pacote Android. Se esse campo for fornecido e sha1_cert_hash não for, a ação vai gerar um erro se ele não corresponder ao nome real do pacote Android.

iosBundleId

string

ID do pacote do iOS para verificar o ID do pacote do iOS real. Se esse campo for fornecido, a ação vai gerar um erro se ele não corresponder ao ID real do pacote do iOS.

clientId

string

O ID do cliente OAuth do RP. Se definido, uma verificação será realizada para garantir que o cliente OAuth seja válido para o projeto recuperado e que a solicitação seja rejeitada com um erro do cliente, se não for válido.

sha1Cert

string

Hash do certificado do aplicativo Android SHA-1. Se definido, uma verificação será realizada para garantir que o hash do certificado seja válido para o projeto recuperado e para o androidPackageName.

firebaseAppId

string

O ID do app do Firebase, para aplicativos que usam o Firebase. Você pode encontrar essa informação no Console do Firebase do seu projeto. Se definido, uma verificação será realizada para garantir que o ID do app seja válido para o projeto recuperado. Se não for válido, a solicitação será rejeitada com um erro do cliente.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para v1.getProjects.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação 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

O ID do projeto da configuração recuperada.

apiKey

string

Chave da API Google Cloud. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

allowPasswordUser

boolean

Define se é possível fazer o registro de contas de senha. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

idpConfig[]

object (IdpConfig)

Configuração do provedor OAuth2. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

authorizedDomains[]

string

Domínios autorizados para redirecionamento de widgets.

enableAnonymousUser

boolean

Indica se o usuário anônimo está ativado. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

useEmailSending

boolean

Se é possível usar o envio de e-mails. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

resetPasswordTemplate

object (EmailTemplate)

Modelo de e-mail para redefinir a senha. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

verifyEmailTemplate

object (EmailTemplate)

Modelo de e-mail para verificação de e-mail. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

changeEmailTemplate

object (EmailTemplate)

Modelo de e-mail para mudança de e-mail. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

legacyResetPasswordTemplate

object (EmailTemplate)

Modelo de e-mail de redefinição de senha para o app Firebase V1 legado. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

revertSecondFactorAdditionTemplate

object (EmailTemplate)

Modelo de e-mail para reverter adição de segundo fator. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

IdpConfig

Configuração de um provedor de identidade.

Representação JSON
{
  "provider": enum (Provider),
  "enabled": boolean,
  "experimentPercent": integer,
  "clientId": string,
  "secret": string,
  "whitelistedAudiences": [
    string
  ]
}
Campos
provider

enum (Provider)

enabled

boolean

Verdadeiro se permite que o usuário faça login com o provedor.

experimentPercent

integer

Porcentagem de usuários que vão receber uma solicitação/redirecionamento de login federado para esse IdP

clientId

string

ID do cliente OAuth2.

secret

string

Secret de cliente OAuth2.

whitelistedAudiences[]

string

IDs de cliente na lista de permissões para verificação de público-alvo.

Provedor

Nome do provedor de identidade.

Enums
PROVIDER_UNSPECIFIED
MSLIVE Microsoft Live como provedor de identidade.
GOOGLE Google como provedor de identidade.
FACEBOOK Facebook como provedor de identidade.
PAYPAL PayPal como provedor de identidade.
TWITTER Twitter como provedor de identidade.
YAHOO Yahoo como provedor de identidade.
AOL AOL como provedor de identidade.
GITHUB GitHub como provedor de identidade.
GOOGLE_PLAY_GAMES Google Play Games como provedor de identidade.
LINKEDIN LinkedIn como provedor de identidade.
IOS_GAME_CENTER O Game Center do iOS como provedor de identidade.

EmailTemplate

Modelo de e-mail

Representação 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 se o modelo está desativado. Se definido como "true", um modelo padrão será usado.

from

string

Endereço de e-mail de origem

body

string

Corpo do e-mail

subject

string

Assunto do e-mail

fromDisplayName

string

Do nome de exibição

format

enum (EmailBodyFormat)

Formato do corpo do e-mail

replyTo

string

Endereço para resposta

fromLocalPart

string

Parte local do endereço "De"

locale

string

O valor está no formato de código de idioma III (por exemplo, "zh-CN", "es"). Os separadores '-' e '_' são aceitos.

customized

boolean

Se o corpo ou o assunto do e-mail é personalizado.

EmailBodyFormat

Formato do corpo do e-mail

Enums
EMAIL_BODY_FORMAT_UNSPECIFIED Valor padrão. Não use.
PLAINTEXT O corpo do e-mail está no formato de texto simples.
HTML O corpo do e-mail está no formato HTML.