Config

Representa um projeto do Identity Toolkit.

Representação JSON 
{
  "name": string,
  "signIn": {
    object (SignInConfig)
  },
  "notification": {
    object (NotificationConfig)
  },
  "quota": {
    object (QuotaConfig)
  },
  "monitoring": {
    object (MonitoringConfig)
  },
  "multiTenant": {
    object (MultiTenantConfig)
  },
  "authorizedDomains": [
    string
  ],
  "subtype": enum (Subtype),
  "client": {
    object (ClientConfig)
  },
  "mfa": {
    object (MultiFactorAuthConfig)
  },
  "blockingFunctions": {
    object (BlockingFunctionsConfig)
  },
  "recaptchaConfig": {
    object (RecaptchaConfig)
  },
  "smsRegionConfig": {
    object (SmsRegionConfig)
  },
  "autodeleteAnonymousUsers": boolean,
  "passwordPolicyConfig": {
    object (PasswordPolicyConfig)
  },
  "emailPrivacyConfig": {
    object (EmailPrivacyConfig)
  },
  "mobileLinksConfig": {
    object (MobileLinksConfig)
  },
  "defaultHostingSite": string
}
Campos
name

string

Apenas saída. O nome do recurso de configuração. Exemplo: "projects/my-awesome-project/config"
signIn

object (SignInConfig)

Configuração relacionada aos métodos de login local.
notification

object (NotificationConfig)

Configuração relacionada ao envio de notificações aos usuários.
quota

object (QuotaConfig)

Configuração relacionada a cotas.
monitoring

object (MonitoringConfig)

Configuração relacionada ao monitoramento da atividade do projeto.
multiTenant

object (MultiTenantConfig)

Configuração relacionada à funcionalidade multilocatário.
authorizedDomains[]

string

Lista de domínios autorizados para redirecionamentos OAuth
subtype

enum (Subtype)

Apenas saída. O subtipo dessa configuração.
client

object (ClientConfig)

Opções relacionadas à configuração de como os clientes que fazem solicitações em nome de um projeto devem ser configurados.
mfa

object (MultiFactorAuthConfig)

Configuração da autenticação multifator do projeto, incluindo se ela está ativa e quais fatores podem ser usados para o segundo fator
blockingFunctions

object (BlockingFunctionsConfig)

Configuração relacionada a funções de bloqueio.
recaptchaConfig

object (RecaptchaConfig)

A configuração do reCAPTCHA no nível do projeto.
smsRegionConfig

object (SmsRegionConfig)

Configura quais regiões estão ativadas para o envio de códigos de verificação por SMS.
autodeleteAnonymousUsers

boolean

Se os usuários anônimos serão excluídos automaticamente após um período de 30 dias.
passwordPolicyConfig

object (PasswordPolicyConfig)

A configuração da política de senha no nível do projeto.
emailPrivacyConfig

object (EmailPrivacyConfig)

Configuração de configurações relacionadas à privacidade de e-mail e visibilidade pública.
defaultHostingSite

string

Apenas saída. Nome do site de hospedagem padrão do Firebase

SignInConfig

Configuração relacionada aos métodos de login local.

Representação JSON 
{
  "email": {
    object (Email)
  },
  "phoneNumber": {
    object (PhoneNumber)
  },
  "anonymous": {
    object (Anonymous)
  },
  "allowDuplicateEmails": boolean,
  "hashConfig": {
    object (HashConfig)
  }
}
Campos
email

object (Email)

Opções de configuração relacionadas à autenticação de um usuário pelo endereço de e-mail.
phoneNumber

object (PhoneNumber)

Opções de configuração relacionadas à autenticação de um usuário pelo número de telefone.
anonymous

object (Anonymous)

Opções de configuração relacionadas à autenticação de um usuário anônimo.
allowDuplicateEmails

boolean

Permitir que mais de uma conta tenha o mesmo e-mail.
hashConfig

object (HashConfig)

Apenas saída. Informações de configuração do hash.

E-mail

Opções de configuração relacionadas à autenticação de um usuário pelo endereço de e-mail.

Representação JSON 
{
  "enabled": boolean,
  "passwordRequired": boolean
}
Campos
enabled

boolean

Indica se a autenticação de e-mail está ativada ou não para o projeto.
passwordRequired

boolean

Se uma senha é necessária para a autenticação de e-mail ou não. Se verdadeiro, um e-mail e uma senha precisam ser fornecidos para fazer login. Se for falso, um usuário poderá fazer login por e-mail/senha ou link de e-mail.

PhoneNumber

Opções de configuração relacionadas à autenticação de um usuário pelo número de telefone.

Representação JSON 
{
  "enabled": boolean,
  "testPhoneNumbers": {
    string: string,
    ...
  }
}
Campos
enabled

boolean

Indica se a autenticação de número de telefone está ativada ou não para o projeto.
testPhoneNumbers

map (key: string, value: string)

Um mapa de <número de telefone de teste, código falso> que pode ser usado para testes de autenticação por telefone.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Anônimo

Opções de configuração relacionadas à autenticação de um usuário anônimo.

Representação JSON 
{
  "enabled": boolean
}
Campos
enabled

boolean

Indica se a autenticação de usuário anônimo está ativada ou não para o projeto.

NotificationConfig

Configuração relacionada ao envio de notificações aos usuários.

Representação JSON 
{
  "sendEmail": {
    object (SendEmail)
  },
  "sendSms": {
    object (SendSms)
  },
  "defaultLocale": string
}
Campos
sendEmail

object (SendEmail)

Opções de envio de e-mails.
sendSms

object (SendSms)

Opções para envio de SMS.
defaultLocale

string

Localidade padrão usada para e-mail e SMS no formato IETF BCP 47.

SendEmail

Opções de envio de e-mails.

Representação JSON 
{
  "method": enum (Method),
  "resetPasswordTemplate": {
    object (EmailTemplate)
  },
  "verifyEmailTemplate": {
    object (EmailTemplate)
  },
  "changeEmailTemplate": {
    object (EmailTemplate)
  },
  "legacyResetPasswordTemplate": {
    object (EmailTemplate)
  },
  "callbackUri": string,
  "dnsInfo": {
    object (DnsInfo)
  },
  "revertSecondFactorAdditionTemplate": {
    object (EmailTemplate)
  },

  // Union field email_provider_config can be only one of the following:
  "smtp": {
    object (Smtp)
  }
  // End of list of possible types for union field email_provider_config.
}
Campos
method

enum (Method)

O método usado para enviar um e-mail.
resetPasswordTemplate

object (EmailTemplate)

Modelo de e-mail para redefinir a senha
verifyEmailTemplate

object (EmailTemplate)

Modelo de e-mail para verificar o e-mail
changeEmailTemplate

object (EmailTemplate)

Modelo de e-mail para mudança de e-mail
legacyResetPasswordTemplate

object (EmailTemplate)

Modelo de e-mail de redefinição de senha para o app Firebase V1 legado.
callbackUri

string

URL de ação no modelo de e-mail.
dnsInfo

object (DnsInfo)

Informações da verificação de DNS do domínio personalizado.
revertSecondFactorAdditionTemplate

object (EmailTemplate)

Modelo de e-mail para reverter e-mails de adição de segundo fator
Campo de união email_provider_config. A configuração do provedor de e-mail usada para enviar e-mails email_provider_config só pode ser uma das seguintes:
smtp

object (Smtp)

Usar um redirecionamento SMTP personalizado

Método

O método usado para enviar um e-mail.

Enums
METHOD_UNSPECIFIED O método de e-mail não foi especificado.
DEFAULT Enviar e-mail em nome do desenvolvedor.
CUSTOM_SMTP Enviar e-mails usando a configuração SMTP fornecida pelos desenvolvedores.

Smtp

Configuração para redirecionamento SMTP

Representação JSON 
{
  "senderEmail": string,
  "host": string,
  "port": integer,
  "username": string,
  "password": string,
  "securityMode": enum (SecurityMode)
}
Campos
senderEmail

string

E-mail do remetente para o redirecionamento SMTP
host

string

Host de redirecionamento SMTP
port

integer

Porta de redirecionamento SMTP
username

string

Nome de usuário do redirecionamento SMTP
password

string

Senha de redirecionamento SMTP
securityMode

enum (SecurityMode)

Modo de segurança do SMTP.

SecurityMode

Modo de segurança do SMTP.

Enums
SECURITY_MODE_UNSPECIFIED Valor padrão. Não use.
SSL Modo SSL
START_TLS Modo START_TLS

EmailTemplate

Modelo de e-mail. Os campos de assunto e corpo podem conter os seguintes marcadores de posição, que serão substituídos pelos valores apropriados: %LINK%: o link a ser usado para resgatar o código OOB enviado. %EMAIL%: o e-mail para onde o e-mail está sendo enviado. %NEW_EMAIL%: o novo e-mail que está sendo definido para a conta (quando aplicável). %APP_NAME%: o nome de exibição do projeto do Google Cloud. %DISPLAY_NAME%: o nome de exibição do usuário.

Representação JSON 
{
  "senderLocalPart": string,
  "subject": string,
  "senderDisplayName": string,
  "body": string,
  "bodyFormat": enum (BodyFormat),
  "replyTo": string,
  "customized": boolean
}
Campos
senderLocalPart

string

Parte local do endereço "De"
subject

string

Assunto do e-mail
senderDisplayName

string

Nome de exibição do remetente
body

string

Corpo do e-mail
bodyFormat

enum (BodyFormat)

Formato do corpo do e-mail
replyTo

string

Endereço para resposta
customized

boolean

Apenas saída. Se o corpo ou o assunto do e-mail é personalizado.

BodyFormat

Formato do corpo do e-mail

Enums
BODY_FORMAT_UNSPECIFIED Valor padrão. Não use.
PLAIN_TEXT Texto simples
HTML HTML

DnsInfo

Informações da verificação de DNS do domínio personalizado. Por padrão, default_domain será usado. Um domínio personalizado pode ser configurado usando o VerifyCustomDomain.

Representação JSON 
{
  "customDomain": string,
  "useCustomDomain": boolean,
  "pendingCustomDomain": string,
  "customDomainState": enum (VerificationState),
  "domainVerificationRequestTime": string
}
Campos
customDomain

string

Apenas saída. O domínio personalizado verificado aplicado.
useCustomDomain

boolean

Se é possível usar um domínio personalizado.
pendingCustomDomain

string

Apenas saída. O domínio personalizado que será verificado.
customDomainState

enum (VerificationState)

Apenas saída. O estado atual da verificação do domínio personalizado. O domínio personalizado só será usado depois que a verificação for concluída.
domainVerificationRequestTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora da solicitação inicial para a verificação de domínio atual.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

SendSms

Opções para envio de SMS.

Representação JSON 
{
  "useDeviceLocale": boolean,
  "smsTemplate": {
    object (SmsTemplate)
  }
}
Campos
useDeviceLocale

boolean

Indica se o cabeçalho accept_language será usado para SMS.
smsTemplate

object (SmsTemplate)

Apenas saída. O modelo a ser usado ao enviar um SMS.

SmsTemplate

O modelo a ser usado ao enviar um SMS.

Representação JSON 
{
  "content": string
}
Campos
content

string

Apenas saída. O conteúdo do SMS. Pode conter os seguintes marcadores de posição, que serão substituídos pelos valores apropriados: %APP_NAME%: para apps Android ou iOS, o nome de exibição do app. Para apps da Web, o domínio que hospeda o aplicativo. %LOGIN_CODE%: o código OOB enviado no SMS.

QuotaConfig

Configuração relacionada a cotas.

Representação JSON 
{
  "signUpQuotaConfig": {
    object (TemporaryQuota)
  }
}
Campos
signUpQuotaConfig

object (TemporaryQuota)

Quota do endpoint de inscrição, se substituída. A cota de inscrições é medida em inscrições por projeto, hora e IP.

TemporaryQuota

Aumento / redução temporária da cota

Representação JSON 
{
  "quota": string,
  "startTime": string,
  "quotaDuration": string
}
Campos
quota

string (int64 format)

Corresponde ao campo "refill_token_count" na configuração do QuotaServer
startTime

string (Timestamp format)

Quando essa cota vai entrar em vigor

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
quotaDuration

string (Duration format)

Por quanto tempo essa cota vai ficar ativa

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

MultiTenantConfig

Configuração relacionada à funcionalidade multilocatário.

Representação JSON 
{
  "allowTenants": boolean,
  "defaultTenantLocation": string
}
Campos
allowTenants

boolean

Indica se o projeto pode ter locatários ou não.
defaultTenantLocation

string

A organização ou pasta principal padrão da nuvem em que o projeto do locatário precisa ser criado. O nome do recurso pai precisa estar no formato "/", como "folders/123" ou "organizations/456". Se o valor não for definido, o locatário será criado na mesma organização ou pasta do projeto do agente.

Subtipo

O subtipo dessa configuração.

Enums
SUBTYPE_UNSPECIFIED Valor padrão. Não use.
IDENTITY_PLATFORM Um projeto do Identity Platform.
FIREBASE_AUTH Um projeto do Firebase Authentication.

ClientConfig

Opções relacionadas à configuração de como os clientes que fazem solicitações em nome de um projeto devem ser configurados.

Representação JSON 
{
  "apiKey": string,
  "permissions": {
    object (Permissions)
  },
  "firebaseSubdomain": string
}
Campos
apiKey

string

Apenas saída. Chave de API que pode ser usada ao fazer solicitações para esse projeto.
permissions

object (Permissions)

Configuração relacionada à restrição da capacidade de um usuário de afetar a conta dele.
firebaseSubdomain

string

Apenas saída. Subdomínio do Firebase.

Permissões

Configuração relacionada à restrição da capacidade de um usuário de afetar a conta dele.

Representação JSON 
{
  "disabledUserSignup": boolean,
  "disabledUserDeletion": boolean
}
Campos
disabledUserSignup

boolean

Quando "true", os usuários finais não podem se inscrever para uma nova conta no projeto associado usando nossos métodos de API
disabledUserDeletion

boolean

Quando definido como "true", os usuários finais não podem excluir a conta no projeto associado usando nenhum dos nossos métodos de API.

BlockingFunctionsConfig

Configuração relacionada a funções de bloqueio.

Representação JSON 
{
  "triggers": {
    string: {
      object (Trigger)
    },
    ...
  },
  "forwardInboundCredentials": {
    object (ForwardInboundCredentials)
  }
}
Campos
triggers

map (key: string, value: object (Trigger))

Mapa do acionador para o tipo de evento. A chave precisa ser um dos tipos de evento com suporte: "beforeCreate", "beforeSignIn"

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
forwardInboundCredentials

object (ForwardInboundCredentials)

As credenciais do usuário a serem incluídas no payload do JWT enviado às funções de bloqueio registradas.

Gatilho

Função do Cloud síncrona com acionador HTTP

Representação JSON 
{
  "functionUri": string,
  "updateTime": string
}
Campos
functionUri

string

Acionador de URI HTTP para a função do Cloud.
updateTime

string (Timestamp format)

Quando o acionador foi alterado.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

ForwardInboundCredentials

Indica quais credenciais serão transmitidas para as funções de bloqueio registradas.

Representação JSON 
{
  "idToken": boolean,
  "accessToken": boolean,
  "refreshToken": boolean
}
Campos
idToken

boolean

Define se o token de ID do provedor de identidade OIDC do usuário será transmitido.
accessToken

boolean

Define se o token de acesso do provedor de identidade OAuth do usuário será transmitido.
refreshToken

boolean

Indica se é necessário transmitir o token de atualização do provedor de identidade OAuth do usuário.