Package google.cloud.identitytoolkit.v2beta1

Índice

ProjectConfigService

Configuração do projeto para o Identity Toolkit

CreateDefaultSupportedIdpConfig

rpc CreateDefaultSupportedIdpConfig(CreateDefaultSupportedIdpConfigRequest) returns (DefaultSupportedIdpConfig)

Crie uma configuração de IdP padrão com suporte para um projeto do Identity Toolkit.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

CreateInboundSamlConfig

rpc CreateInboundSamlConfig(CreateInboundSamlConfigRequest) returns (InboundSamlConfig)

Crie uma configuração de SAML de entrada para um projeto do Identity Toolkit.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

CreateOAuthIdpConfig

rpc CreateOAuthIdpConfig(CreateOAuthIdpConfigRequest) returns (OAuthIdpConfig)

Crie uma configuração de IdP Oidc para um projeto do Identity Toolkit.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

DeleteDefaultSupportedIdpConfig

rpc DeleteDefaultSupportedIdpConfig(DeleteDefaultSupportedIdpConfigRequest) returns (Empty)

Exclua uma configuração de IdP padrão com suporte para um projeto do Identity Toolkit.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

DeleteInboundSamlConfig

rpc DeleteInboundSamlConfig(DeleteInboundSamlConfigRequest) returns (Empty)

Exclua uma configuração de SAML de entrada para um projeto do Identity Toolkit.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

DeleteOAuthIdpConfig

rpc DeleteOAuthIdpConfig(DeleteOAuthIdpConfigRequest) returns (Empty)

Exclua uma configuração de IdP Oidc para um projeto do Identity Toolkit.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

EnableCicp

rpc EnableCicp(EnableCicpRequest) returns (EnableCicpResponse)

Ative o CICP para um projeto do Cloud. O Cloud Identity for Customers and Partners (CICP) é um sistema de autenticação de ponta a ponta para que usuários externos acessem seus apps e serviços. Isso pode incluir apps para dispositivos móveis/Web, jogos, APIs e muito mais.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

GetConfig

rpc GetConfig(GetConfigRequest) returns (Config)

Extrair uma configuração de projeto do Identity Toolkit.

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.

GetDefaultSupportedIdpConfig

rpc GetDefaultSupportedIdpConfig(GetDefaultSupportedIdpConfigRequest) returns (DefaultSupportedIdpConfig)

Extraia uma configuração de IdP padrão com suporte para um projeto do Identity Toolkit.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

GetInboundSamlConfig

rpc GetInboundSamlConfig(GetInboundSamlConfigRequest) returns (InboundSamlConfig)

Extraia uma configuração de SAML de entrada para um projeto do Identity Toolkit.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

GetOAuthIdpConfig

rpc GetOAuthIdpConfig(GetOAuthIdpConfigRequest) returns (OAuthIdpConfig)

Extraia uma configuração de IdP Oidc para um projeto do Identity Toolkit.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

ListDefaultSupportedIdpConfigs

rpc ListDefaultSupportedIdpConfigs(ListDefaultSupportedIdpConfigsRequest) returns (ListDefaultSupportedIdpConfigsResponse)

Lista todas as configurações de IdP padrão com suporte para um projeto do Identity Toolkit.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

ListDefaultSupportedIdps

rpc ListDefaultSupportedIdps(ListDefaultSupportedIdpsRequest) returns (ListDefaultSupportedIdpsResponse)

Lista todos os IdPs padrão compatíveis.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

ListInboundSamlConfigs

rpc ListInboundSamlConfigs(ListInboundSamlConfigsRequest) returns (ListInboundSamlConfigsResponse)

Listar todas as configurações de entrada de SAML para um projeto do Identity Toolkit.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

ListOAuthIdpConfigs

rpc ListOAuthIdpConfigs(ListOAuthIdpConfigsRequest) returns (ListOAuthIdpConfigsResponse)

Lista todas as configurações de Idp Oidc para um projeto do Identity Toolkit.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

UpdateConfig

rpc UpdateConfig(UpdateConfigRequest) returns (Config)

Atualizar a configuração de um projeto do Identity Toolkit.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

UpdateDefaultSupportedIdpConfig

rpc UpdateDefaultSupportedIdpConfig(UpdateDefaultSupportedIdpConfigRequest) returns (DefaultSupportedIdpConfig)

Atualize uma configuração de idp padrão com suporte para um projeto do Identity Toolkit.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

UpdateInboundSamlConfig

rpc UpdateInboundSamlConfig(UpdateInboundSamlConfigRequest) returns (InboundSamlConfig)

Atualize uma configuração de SAML de entrada para um projeto do Identity Toolkit.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

UpdateOAuthIdpConfig

rpc UpdateOAuthIdpConfig(UpdateOAuthIdpConfigRequest) returns (OAuthIdpConfig)

Atualize uma configuração de Oidc Idp para um projeto do Identity Toolkit.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

VerifyDomain

rpc VerifyDomain(VerifyDomainRequest) returns (VerifyDomainResponse)

Verifique se o domínio personalizado solicitado tem os registros DNS necessários.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

TenantManagementService

Serviço de gerenciamento de inquilinos para o GCIP.

CreateTenant

rpc CreateTenant(CreateTenantRequest) returns (Tenant)

Crie um locatário. Requer permissão de gravação no projeto do agente.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

DeleteTenant

rpc DeleteTenant(DeleteTenantRequest) returns (Empty)

Excluir um locatário. Requer permissão de gravação no projeto do agente.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

GetTenant

rpc GetTenant(GetTenantRequest) returns (Tenant)

Acesse um locatário. Requer permissão de leitura no recurso do locatário.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

ListTenants

rpc ListTenants(ListTenantsRequest) returns (ListTenantsResponse)

Lista os locatários no projeto de agente fornecido. Requer permissão de leitura no projeto do agente.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

UpdateTenant

rpc UpdateTenant(UpdateTenantRequest) returns (Tenant)

Atualizar um locatário. Requer permissão de gravação no recurso do locatário.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

BlockingFunctionsConfig

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

Campos
triggers

map<string, Trigger>

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

Gatilho

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

Campos
function_uri

string

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

update_time

Timestamp

Quando o acionador foi alterado.

ClientConfig

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

Campos
api_key

string

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

permissions

Permissions

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

firebase_subdomain

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.

Campos
disabled_user_signup

bool

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

disabled_user_deletion

bool

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.

Configuração

Representa um projeto do Identity Toolkit.

Campos
name

string

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

sign_in

SignInConfig

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

notification

NotificationConfig

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

quota

QuotaConfig

Configuração relacionada a cotas.

monitoring

MonitoringConfig

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

authorized_domains[]

string

Lista de domínios autorizados para redirecionamentos OAuth

subtype

Subtype

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

client

ClientConfig

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

mfa

MultiFactorAuthConfig

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

blocking_functions

BlockingFunctionsConfig

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

Subtipo

O subtipo dessa configuração.

Enums
SUBTYPE_UNSPECIFIED Valor padrão. Não use.
CUSTOMER_IDENTITY Um projeto de identidade do cliente.
FIREBASE_AUTH Um projeto do Firebase Authentication.

CreateDefaultSupportedIdpConfigRequest

Solicitação para CreateDefaultSupportedIdpConfig

Campos
parent

string

O nome do recurso pai em que a configuração será criada, por exemplo: "projects/my-awesome-project"

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • firebaseauth.configs.update
idp_id

string

O ID do IdP para criar uma configuração. Chame ListDefaultSupportedIdps para ver uma lista de todos os IdPs padrão compatíveis.

default_supported_idp_config

DefaultSupportedIdpConfig

O recurso de configuração que substitui o recurso no servidor.

CreateInboundSamlConfigRequest

Solicitação para CreateInboundSamlConfig

Campos
parent

string

O nome do recurso pai em que a configuração será criada, por exemplo: "projects/my-awesome-project"

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • firebaseauth.configs.update
inbound_saml_config_id

string

O ID a ser usado para essa configuração.

inbound_saml_config

InboundSamlConfig

O recurso de configuração a ser criado. O cliente não pode definir o campo InboundSamlConfig.name, e o servidor vai ignorar o valor do campo se ele for definido pelos clientes.

CreateOAuthIdpConfigRequest

Solicitação para CreateOAuthIdpConfig

Campos
parent

string

O nome do recurso pai em que a configuração será criada, por exemplo: "projects/my-awesome-project"

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • firebaseauth.configs.update
oauth_idp_config_id

string

O ID a ser usado para essa configuração.

oauth_idp_config

OAuthIdpConfig

O recurso de configuração a ser criado. O cliente não pode definir o campo OAuthIdpConfig.name, e o servidor vai ignorar o valor do campo se ele for definido pelos clientes.

CreateTenantRequest

Mensagem de solicitação para CreateTenant.

Campos
parent

string

O nome do recurso pai em que o locatário será criado. Por exemplo, "projects/project1".

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • identitytoolkit.tenants.create
tenant

Tenant

Obrigatório. Inquilino a ser criado.

DefaultSupportedIdp

Provedores de identidade padrão confiáveis do Identity Toolkit.

Campos
idp_id

string

Identifique o IdP

description

string

Descrição do IdP

DefaultSupportedIdpConfig

Opções de configuração para autenticação com um conjunto padrão de provedores de identidade confiáveis do Identity Toolkit.

Campos
name

string

O nome do recurso DefaultSupportedIdpConfig, por exemplo: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com"

enabled

bool

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

client_id

string

ID do cliente OAuth.

client_secret

string

Chave secreta do cliente OAuth.

display_on_cloud_console

bool

Apenas saída. Indica se a configuração do IdP será mostrada no Pantheon se ele estiver desativado.

DeleteDefaultSupportedIdpConfigRequest

Solicitação para DeleteDefaultSupportedIdpConfig.

Campos
name

string

O nome do recurso da configuração, por exemplo: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com"

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • firebaseauth.configs.update

DeleteInboundSamlConfigRequest

Solicitação para DeleteInboundSamlConfig

Campos
name

string

O nome do recurso da configuração a ser excluída, por exemplo: "projects/my-awesome-project/inboundSamlConfigs/my-config-id".

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • firebaseauth.configs.update

DeleteOAuthIdpConfigRequest

Solicitação para DeleteOAuthIdpConfig

Campos
name

string

O nome do recurso da configuração a ser excluída, por exemplo: "projects/my-awesome-project/oauthIdpConfigs/oauth-config-id".

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • firebaseauth.configs.update

DeleteTenantRequest

Mensagem de solicitação para DeleteTenant.

Campos
name

string

Nome do recurso do locatário a ser excluído.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • identitytoolkit.tenants.delete

EnableCicpRequest

Solicitação para EnableCicp.

Campos
project

string

O nome do recurso do projeto de destino para o qual o desenvolvedor quer ativar o CICP.

A autorização requer a seguinte permissão do IAM no recurso especificado project:

  • firebaseauth.configs.create

EnableCicpResponse

Esse tipo não tem campos.

Resposta para EnableCicp. Vazio por enquanto.

GetConfigRequest

Solicitação para GetConfig

Campos
name

string

O nome do recurso da configuração, por exemplo: "projects/my-awesome-project/config"

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • firebaseauth.configs.get

GetDefaultSupportedIdpConfigRequest

Solicitação para GetDefaultSupportedIdpConfig.

Campos
name

string

O nome do recurso da configuração, por exemplo: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com"

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • firebaseauth.configs.get

GetInboundSamlConfigRequest

Solicitação de GetInboundSamlConfig

Campos
name

string

O nome do recurso da configuração, por exemplo: "projects/my-awesome-project/inboundSamlConfigs/my-config-id".

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • firebaseauth.configs.get

GetOAuthIdpConfigRequest

Solicitação para GetOAuthIdpConfig

Campos
name

string

O nome do recurso da configuração, por exemplo: "projects/my-awesome-project/oauthIdpConfigs/oauth-config-id".

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • firebaseauth.configs.get

GetTenantRequest

Mensagem de solicitação para GetTenant.

Campos
name

string

Nome do recurso do locatário a ser recuperado.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • identitytoolkit.tenants.get

HashConfig

Informações históricas do algoritmo de hash e da chave. As senhas de contas diferentes podem ser geradas por versões diferentes.

Campos
algorithm

HashAlgorithm

Apenas saída. Diferentes algoritmos de hash de senha usados no Identity Toolkit.

signer_key

string

Apenas saída. Chave do assinante em base64.

salt_separator

string

Apenas saída. Caractere não imprimível a ser inserido entre o sal e a senha de texto simples em base64.

rounds

int32

Apenas saída. Quantas rodadas para o cálculo de hash. Usado por scrypt e outros algoritmos de derivação de senha semelhantes.

memory_cost

int32

Apenas saída. Custo de memória para cálculo de hash. Usado por scrypt e outros algoritmos de derivação de senha semelhantes. Consulte https://tools.ietf.org/html/rfc7914 para uma explicação do campo.

HashAlgorithm

Diferentes algoritmos de hash de senha usados no Identity Toolkit.

Enums
HASH_ALGORITHM_UNSPECIFIED Valor padrão. Não use.
HMAC_SHA256 HMAC_SHA256
HMAC_SHA1 HMAC_SHA1
HMAC_MD5 HMAC_MD5
SCRYPT SCRYPT
PBKDF_SHA1 PBKDF_SHA1
MD5 MD5
HMAC_SHA512 HMAC_SHA512
SHA1 SHA1
BCRYPT BCRYPT
PBKDF2_SHA256 PBKDF2_SHA256
SHA256 SHA256
SHA512 SHA512
STANDARD_SCRYPT STANDARD_SCRYPT

IdpCertificate

O proto para os dados do certificado do IDP para verificar a assinatura na SAMLResponse emitida pelo IDP.

Campos
x509_certificate

string

O certificado x509

InboundSamlConfig

O proto para armazenar um par de configurações de RP-IDP SAML quando o projeto atua como a parte confiável.

Campos
name

string

O nome do recurso InboundSamlConfig, por exemplo: "projects/my-awesome-project/inboundSamlConfigs/my-config-id". Ignorado durante solicitações de criação.

idp_config

IdpConfig

O proto para armazenar a configuração do IdP (provedor de identidade) SAML quando o projeto atua como parte confiável.

sp_config

SpConfig

O proto para armazenar a configuração do SAML SP (provedor de serviços) quando o projeto atua como a parte confiável para receber e aceitar uma declaração de autenticação emitida por um provedor de identidade SAML.

display_name

string

O nome de exibição da configuração definido pelos desenvolvedores.

enabled

bool

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

IdpConfig

O proto para armazenar a configuração do IdP (provedor de identidade) SAML quando o projeto atua como parte confiável.

Campos
idp_entity_id

string

Identificador exclusivo para todas as entidades SAML.

sso_url

string

URL para enviar a solicitação de autenticação.

idp_certificates[]

IdpCertificate

Chaves públicas do IDP para verificar a assinatura nas declarações.

sign_request

bool

Indica se a SAMLRequest de saída precisa ser assinada.

SpConfig

O proto para armazenar a configuração do SAML SP (provedor de serviços) quando o projeto atua como a parte confiável para receber e aceitar uma declaração de autenticação emitida por um provedor de identidade SAML.

Campos
sp_entity_id

string

Identificador exclusivo para todas as entidades SAML.

callback_uri

string

URI de callback em que as respostas do IDP são processadas.

sp_certificates[]

SpCertificate

Apenas saída. Certificados públicos gerados pelo servidor para verificar a assinatura em SAMLRequest no fluxo iniciado pelo SP.

ListDefaultSupportedIdpConfigsRequest

Solicitação para ListDefaultSupportedIdpConfigs

Campos
parent

string

O nome do recurso pai, por exemplo, "projects/my-awesome-project".

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • firebaseauth.configs.get
page_size

int32

O número máximo de itens para retornar.

page_token

string

O valor next_page_token retornado de uma solicitação List anterior, se houver.

ListDefaultSupportedIdpConfigsResponse

Resposta para ListDefaultSupportedIdpConfigs

Campos
default_supported_idp_configs[]

DefaultSupportedIdpConfig

O conjunto de configurações.

next_page_token

string

Token para recuperar a próxima página de resultados ou vazia se não houver mais resultados na lista.

ListDefaultSupportedIdpsRequest

Solicitação para ListDefaultSupportedIdps

Campos
page_size

int32

O número máximo de itens para retornar.

page_token

string

O valor next_page_token retornado de uma solicitação List anterior, se houver.

ListDefaultSupportedIdpsResponse

Resposta para ListDefaultSupportedIdps

Campos
default_supported_idps[]

DefaultSupportedIdp

O conjunto de configurações.

next_page_token

string

Token para recuperar a próxima página de resultados ou vazia se não houver mais resultados na lista.

ListInboundSamlConfigsRequest

Solicitação para ListInboundSamlConfigs

Campos
parent

string

O nome do recurso pai, por exemplo, "projects/my-awesome-project".

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • firebaseauth.configs.get
page_size

int32

O número máximo de itens para retornar.

page_token

string

O valor next_page_token retornado de uma solicitação List anterior, se houver.

ListInboundSamlConfigsResponse

Resposta para ListInboundSamlConfigs

Campos
inbound_saml_configs[]

InboundSamlConfig

O conjunto de configurações.

next_page_token

string

Token para recuperar a próxima página de resultados ou vazia se não houver mais resultados na lista.

ListOAuthIdpConfigsRequest

Solicitação para ListOAuthIdpConfigs

Campos
parent

string

O nome do recurso pai, por exemplo, "projects/my-awesome-project".

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • firebaseauth.configs.get
page_size

int32

O número máximo de itens para retornar.

page_token

string

O valor next_page_token retornado de uma solicitação List anterior, se houver.

ListOAuthIdpConfigsResponse

Resposta para ListOAuthIdpConfigs

Campos
oauth_idp_configs[]

OAuthIdpConfig

O conjunto de configurações.

next_page_token

string

Token para recuperar a próxima página de resultados ou vazia se não houver mais resultados na lista.

ListTenantsRequest

Mensagem de solicitação para ListTenants.

Campos
parent

string

Obrigatório. O nome do recurso pai para listar locatários.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • identitytoolkit.tenants.list
page_token

string

O token de paginação da resposta de uma solicitação anterior.

page_size

int32

O número máximo de resultados a serem retornados, limitado a 1.000. Se não for especificado, o valor padrão será 20.

ListTenantsResponse

Mensagem de resposta para ListTenants.

Campos
tenants[]

Tenant

Uma lista de locatários no projeto do agente.

next_page_token

string

O token para acessar a próxima página de resultados.

MonitoringConfig

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

Campos
request_logging

RequestLogging

Configuração para registrar solicitações feitas a este projeto no Stackdriver Logging

RequestLogging

Configuração para registrar solicitações feitas a este projeto no Stackdriver Logging

Campos
enabled

bool

Se a geração de registros está ativada ou não para este projeto.

MultiFactorAuthConfig

Opções relacionadas à autenticação multifator para o projeto.

Campos
state

State

Se a autenticação multifator foi ativada para este projeto.

enabled_providers[]

Provider

Uma lista de segundos fatores utilizáveis para este projeto.

Provedor

Uma lista de segundos fatores utilizáveis para este projeto.

Enums
PROVIDER_UNSPECIFIED Provedor ilegal, não deve ser usado
PHONE_SMS O SMS está ativado como segunda etapa para este projeto.

Estado

Se a autenticação multifator foi ativada para este projeto.

Enums
STATE_UNSPECIFIED Estado ilegal, não deve ser usado.
DISABLED A autenticação multifator não pode ser usada para este projeto
ENABLED A autenticação multifator pode ser usada para este projeto
ADMIN_ENABLED A autenticação multifator pode ser usada para este projeto, mas só pode ser configurada pelos administradores do projeto

NotificationConfig

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

Campos
send_email

SendEmail

Opções de envio de e-mails.

send_sms

SendSms

Opções para envio de SMS.

default_locale

string

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

SendEmail

Opções de envio de e-mails.

Campos
method

Method

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

reset_password_template

EmailTemplate

Modelo de e-mail para redefinir a senha

verify_email_template

EmailTemplate

Modelo de e-mail para verificar o e-mail

change_email_template

EmailTemplate

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

legacy_reset_password_template

EmailTemplate

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

callback_uri

string

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

dns_info

DnsInfo

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

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

Smtp

Usar um redirecionamento SMTP personalizado

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.

Campos
custom_domain

string

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

use_custom_domain

bool

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

pending_custom_domain

string

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

custom_domain_state

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.

domain_verification_request_time

Timestamp

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

VerificationState

O estado atual da verificação do domínio personalizado.

Enums
VERIFICATION_STATE_UNSPECIFIED Valor padrão. Não use.
NOT_STARTED A verificação não foi iniciada.
IN_PROGRESS A verificação está em andamento.
FAILED Houve uma falha na verificação.
SUCCEEDED A verificação foi concluída e está pronta para ser aplicada.

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.

Campos
sender_local_part

string

Parte local do endereço "De"

subject

string

Assunto do e-mail

sender_display_name

string

Nome de exibição do remetente

body

string

Corpo do e-mail

body_format

BodyFormat

Formato do corpo do e-mail

reply_to

string

Endereço para resposta

customized

bool

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

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

Campos
sender_email

string

E-mail do remetente para o redirecionamento SMTP

host

string

Host de redirecionamento SMTP

port

int32

Porta de redirecionamento SMTP

username

string

Nome de usuário do redirecionamento SMTP

password

string

Senha de redirecionamento SMTP

security_mode

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

SendSms

Opções para envio de SMS.

Campos
use_device_locale

bool

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

sms_template

SmsTemplate

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

SmsTemplate

O modelo a ser usado ao enviar um SMS.

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.

OAuthIdpConfig

Opções de configuração para autenticação com um IdP OAuth.

Campos
name

string

O nome do recurso OAuthIdpConfig, por exemplo: "projects/my-awesome-project/oauthIdpConfigs/oauth-config-id". Ignorado durante solicitações de criação.

client_id

string

O ID do cliente de um cliente OAuth.

issuer

string

Para provedores de identidade do OIDC, o identificador do emissor.

display_name

string

O nome de exibição da configuração definido pelos desenvolvedores.

enabled

bool

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

client_secret

string

A chave secreta do cliente OAuth, para ativar o fluxo de código do OIDC.

response_type

OAuthResponseType

O tipo de resposta a ser solicitado no fluxo de autorização do OAuth. É possível definir id_token ou code como verdadeiro, mas não ambos. Ainda não é possível definir os dois tipos como verdadeiros simultaneamente ({code: true, id_token: true}).

OAuthResponseType

O tipo de resposta a ser solicitado no fluxo de autorização do OAuth. É possível definir id_token ou code como verdadeiro, mas não ambos. Ainda não é possível definir os dois tipos como verdadeiros simultaneamente ({code: true, id_token: true}).

Consulte https://openid.net/specs/openid-connect-core-1_0.html#Authentication para conferir um mapeamento do tipo de resposta para o fluxo OAuth 2.0.

Campos
id_token

bool

Se verdadeiro, o token de ID é retornado do endpoint de autorização do IdP.

code

bool

Se for verdadeiro, o código de autorização será retornado do endpoint de autorização do IdP.

token
(deprecated)

bool

Não use. O tipo de resposta token não é compatível no momento.

QuotaConfig

Configuração relacionada a cotas.

Campos
sign_up_quota_config

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

Campos
quota

int64

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

start_time

Timestamp

Quando essa cota vai entrar em vigor

quota_duration

Duration

Por quanto tempo essa cota vai ficar ativa

SignInConfig

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

Campos
email

Email

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

phone_number

PhoneNumber

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

anonymous

Anonymous

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

allow_duplicate_emails

bool

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

hash_config

HashConfig

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

Anônimo

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

Campos
enabled

bool

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

E-mail

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

Campos
enabled

bool

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

password_required

bool

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.

hash_config

HashConfig

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

PhoneNumber

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

Campos
enabled

bool

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

test_phone_numbers

map<string, string>

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

SpCertificate

O proto dos dados do certificado do SP para o IDP verificar a solicitação SAML gerada pelo SP.

Campos
x509_certificate

string

Certificado público autoassinado.

expires_at

Timestamp

Carimbo de data/hora da instância de expiração do certificado.

Locatário

Um locatário contém a configuração para o locatário em um projeto multilocatário.

Campos
name

string

Nome do recurso de um locatário. Por exemplo: "projects/project1/tenants/tenant1"

display_name

string

Nome de exibição do locatário.

saml_configs[]
(deprecated)

SamlConfig

Configurações SAML solicitadas.

idp_configs[]
(deprecated)

IdpConfig

Configurações do IDP solicitadas.

allow_password_signup

bool

Define se o registro por e-mail/senha é permitido.

disable_auth

bool

Indica se o locatário está desativado para autenticação. Os usuários do locatário desativado não podem fazer login. Os administradores do locatário desativado não podem gerenciar os usuários.

UpdateConfigRequest

Solicitação para UpdateConfig

Campos
config

Config

O recurso de configuração que substitui o recurso no servidor.

A autorização requer a seguinte permissão do IAM no recurso especificado config:

  • firebaseauth.configs.update
update_mask

FieldMask

A máscara de atualização aplica-se ao recurso. Os campos definidos na configuração, mas não incluídos nessa máscara de atualização, serão ignorados. Para a definição de FieldMask, consulte https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

UpdateDefaultSupportedIdpConfigRequest

Solicitação para UpdateDefaultSupportedIdpConfig

Campos
default_supported_idp_config

DefaultSupportedIdpConfig

O recurso de configuração que substitui o recurso no servidor.

A autorização requer a seguinte permissão do IAM no recurso especificado defaultSupportedIdpConfig:

  • firebaseauth.configs.update
update_mask

FieldMask

A máscara de atualização aplica-se ao recurso. Para a definição de FieldMask, consulte https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

UpdateInboundSamlConfigRequest

Solicitação para UpdateInboundSamlConfig

Campos
inbound_saml_config

InboundSamlConfig

O recurso de configuração que substitui o recurso no servidor.

A autorização requer a seguinte permissão do IAM no recurso especificado inboundSamlConfig:

  • firebaseauth.configs.update
update_mask

FieldMask

A máscara de atualização aplica-se ao recurso. Uma máscara de atualização vazia não atualiza nada. Para a definição de FieldMask, consulte https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

UpdateOAuthIdpConfigRequest

Solicitação para UpdateOAuthIdpConfig

Campos
oauth_idp_config

OAuthIdpConfig

O recurso de configuração que substitui o recurso no servidor.

A autorização requer a seguinte permissão do IAM no recurso especificado oauthIdpConfig:

  • firebaseauth.configs.update
update_mask

FieldMask

A máscara de atualização aplica-se ao recurso. Uma máscara de atualização vazia não atualiza nada. Para a definição de FieldMask, consulte https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

UpdateTenantRequest

Mensagem de solicitação para UpdateTenant.

Campos
tenant

Tenant

Obrigatório. Inquilino a ser atualizado.

A autorização requer a seguinte permissão do IAM no recurso especificado tenant:

  • identitytoolkit.tenants.update
update_mask

FieldMask

A máscara de atualização aplica-se ao recurso. Para a definição de FieldMask, consulte https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

VerifyDomainRequest

Mensagem de solicitação para verificar se o domínio personalizado solicitado tem os registros DNS necessários.

Campos
resource

string

O nome do recurso para verificar o domínio. No momento, esse método aceita a verificação de domínios para projetos (por exemplo, "projects/my-awesome-project") ou locatários (por exemplo, "projects/my-awesome-project/tenants/my-awesome-tenant").

A autorização requer a seguinte permissão do IAM no recurso especificado resource:

  • firebaseauth.configs.update
domain

string

O domínio de destino desta solicitação.

action

DomainVerificationAction

A ação que está sendo tentada no domínio fornecido.

DomainVerificationAction

A ação que está sendo tentada no domínio fornecido.

Enums
DOMAIN_VERIFICATION_ACTION_UNSPECIFIED Valor padrão. Não use.
VERIFY Verifique o domínio em questão.
CANCEL Cancele o processo de verificação atual.
APPLY Aplicar o domínio personalizado ao envio de e-mails.

VerifyDomainResponse

Resposta para a solicitação VerifyDomain.

Campos
verification_state

VerificationState

O estado resultante do domínio após o processamento da solicitação.

verification_error

string

Quando aplicável, uma explicação textual sobre por que o domínio não foi verificado.