Índice
ProjectConfigService
(interface)TenantManagementService
(interface)BlockingFunctionsConfig
(mensagem)BlockingFunctionsConfig.Trigger
(mensagem)ClientConfig
(mensagem)ClientConfig.Permissions
(mensagem)Config
(mensagem)Config.Subtype
(enum)CreateDefaultSupportedIdpConfigRequest
(mensagem)CreateInboundSamlConfigRequest
(mensagem)CreateOAuthIdpConfigRequest
(mensagem)CreateTenantRequest
(mensagem)DefaultSupportedIdp
(mensagem)DefaultSupportedIdpConfig
(mensagem)DeleteDefaultSupportedIdpConfigRequest
(mensagem)DeleteInboundSamlConfigRequest
(mensagem)DeleteOAuthIdpConfigRequest
(mensagem)DeleteTenantRequest
(mensagem)EnableCicpRequest
(mensagem)EnableCicpResponse
(mensagem)GetConfigRequest
(mensagem)GetDefaultSupportedIdpConfigRequest
(mensagem)GetInboundSamlConfigRequest
(mensagem)GetOAuthIdpConfigRequest
(mensagem)GetTenantRequest
(mensagem)HashConfig
(mensagem)HashConfig.HashAlgorithm
(enum)IdpCertificate
(mensagem)InboundSamlConfig
(mensagem)InboundSamlConfig.IdpConfig
(mensagem)InboundSamlConfig.SpConfig
(mensagem)ListDefaultSupportedIdpConfigsRequest
(mensagem)ListDefaultSupportedIdpConfigsResponse
(mensagem)ListDefaultSupportedIdpsRequest
(mensagem)ListDefaultSupportedIdpsResponse
(mensagem)ListInboundSamlConfigsRequest
(mensagem)ListInboundSamlConfigsResponse
(mensagem)ListOAuthIdpConfigsRequest
(mensagem)ListOAuthIdpConfigsResponse
(mensagem)ListTenantsRequest
(mensagem)ListTenantsResponse
(mensagem)MonitoringConfig
(mensagem)MonitoringConfig.RequestLogging
(mensagem)MultiFactorAuthConfig
(mensagem)MultiFactorAuthConfig.Provider
(enum)MultiFactorAuthConfig.State
(enum)NotificationConfig
(mensagem)NotificationConfig.SendEmail
(mensagem)NotificationConfig.SendEmail.DnsInfo
(mensagem)NotificationConfig.SendEmail.DnsInfo.VerificationState
(enum)NotificationConfig.SendEmail.EmailTemplate
(mensagem)NotificationConfig.SendEmail.EmailTemplate.BodyFormat
(enum)NotificationConfig.SendEmail.Method
(enum)NotificationConfig.SendEmail.Smtp
(mensagem)NotificationConfig.SendEmail.Smtp.SecurityMode
(enum)NotificationConfig.SendSms
(mensagem)NotificationConfig.SendSms.SmsTemplate
(mensagem)OAuthIdpConfig
(mensagem)OAuthIdpConfig.OAuthResponseType
(mensagem)QuotaConfig
(mensagem)QuotaConfig.TemporaryQuota
(mensagem)SignInConfig
(mensagem)SignInConfig.Anonymous
(mensagem)SignInConfig.Email
(mensagem)SignInConfig.PhoneNumber
(mensagem)SpCertificate
(mensagem)Tenant
(mensagem)UpdateConfigRequest
(mensagem)UpdateDefaultSupportedIdpConfigRequest
(mensagem)UpdateInboundSamlConfigRequest
(mensagem)UpdateOAuthIdpConfigRequest
(mensagem)UpdateTenantRequest
(mensagem)VerifyDomainRequest
(mensagem)VerifyDomainRequest.DomainVerificationAction
(enum)VerifyDomainResponse
(mensagem)
ProjectConfigService
Configuração do projeto para o Identity Toolkit
CreateDefaultSupportedIdpConfig |
---|
Crie uma configuração de IdP padrão com suporte para um projeto do Identity Toolkit.
|
CreateInboundSamlConfig |
---|
Crie uma configuração de SAML de entrada para um projeto do Identity Toolkit.
|
CreateOAuthIdpConfig |
---|
Crie uma configuração de IdP Oidc para um projeto do Identity Toolkit.
|
DeleteDefaultSupportedIdpConfig |
---|
Exclua uma configuração de IdP padrão com suporte para um projeto do Identity Toolkit.
|
DeleteInboundSamlConfig |
---|
Exclua uma configuração de SAML de entrada para um projeto do Identity Toolkit.
|
DeleteOAuthIdpConfig |
---|
Exclua uma configuração de IdP Oidc para um projeto do Identity Toolkit.
|
EnableCicp |
---|
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.
|
GetConfig |
---|
Extrair uma configuração de projeto do Identity Toolkit.
|
GetDefaultSupportedIdpConfig |
---|
Extraia uma configuração de IdP padrão com suporte para um projeto do Identity Toolkit.
|
GetInboundSamlConfig |
---|
Extraia uma configuração de SAML de entrada para um projeto do Identity Toolkit.
|
GetOAuthIdpConfig |
---|
Extraia uma configuração de IdP Oidc para um projeto do Identity Toolkit.
|
ListDefaultSupportedIdpConfigs |
---|
Lista todas as configurações de IdP padrão com suporte para um projeto do Identity Toolkit.
|
ListDefaultSupportedIdps |
---|
Lista todos os IdPs padrão compatíveis.
|
ListInboundSamlConfigs |
---|
Listar todas as configurações de entrada de SAML para um projeto do Identity Toolkit.
|
ListOAuthIdpConfigs |
---|
Lista todas as configurações de Idp Oidc para um projeto do Identity Toolkit.
|
UpdateConfig |
---|
Atualizar a configuração de um projeto do Identity Toolkit.
|
UpdateDefaultSupportedIdpConfig |
---|
Atualize uma configuração de idp padrão com suporte para um projeto do Identity Toolkit.
|
UpdateInboundSamlConfig |
---|
Atualize uma configuração de SAML de entrada para um projeto do Identity Toolkit.
|
UpdateOAuthIdpConfig |
---|
Atualize uma configuração de Oidc Idp para um projeto do Identity Toolkit.
|
VerifyDomain |
---|
Verifique se o domínio personalizado solicitado tem os registros DNS necessários.
|
TenantManagementService
Serviço de gerenciamento de inquilinos para o GCIP.
CreateTenant |
---|
Crie um locatário. Requer permissão de gravação no projeto do agente.
|
DeleteTenant |
---|
Excluir um locatário. Requer permissão de gravação no projeto do agente.
|
GetTenant |
---|
Acesse um locatário. Requer permissão de leitura no recurso do locatário.
|
ListTenants |
---|
Lista os locatários no projeto de agente fornecido. Requer permissão de leitura no projeto do agente.
|
UpdateTenant |
---|
Atualizar um locatário. Requer permissão de gravação no recurso do locatário.
|
BlockingFunctionsConfig
Configuração relacionada a funções de bloqueio.
Campos | |
---|---|
triggers |
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 |
Acionador de URI HTTP para a função do Cloud. |
update_time |
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 |
Apenas saída. Chave de API que pode ser usada ao fazer solicitações para esse projeto. |
permissions |
Configuração relacionada à restrição da capacidade de um usuário de afetar a conta dele. |
firebase_subdomain |
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 |
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 |
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 |
Apenas saída. O nome do recurso de configuração. Exemplo: "projects/my-awesome-project/config" |
sign_in |
Configuração relacionada aos métodos de login local. |
notification |
Configuração relacionada ao envio de notificações aos usuários. |
quota |
Configuração relacionada a cotas. |
monitoring |
Configuração relacionada ao monitoramento da atividade do projeto. |
authorized_domains[] |
Lista de domínios autorizados para redirecionamentos OAuth |
subtype |
Apenas saída. O subtipo dessa configuração. |
client |
Opções relacionadas à configuração de como os clientes que fazem solicitações em nome de um projeto. |
mfa |
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 |
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 |
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
|
idp_id |
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 |
O recurso de configuração que substitui o recurso no servidor. |
CreateInboundSamlConfigRequest
Solicitação para CreateInboundSamlConfig
Campos | |
---|---|
parent |
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
|
inbound_saml_config_id |
O ID a ser usado para essa configuração. |
inbound_saml_config |
O recurso de configuração a ser criado. O cliente não pode definir o campo |
CreateOAuthIdpConfigRequest
Solicitação para CreateOAuthIdpConfig
Campos | |
---|---|
parent |
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
|
oauth_idp_config_id |
O ID a ser usado para essa configuração. |
oauth_idp_config |
O recurso de configuração a ser criado. O cliente não pode definir o campo |
CreateTenantRequest
Mensagem de solicitação para CreateTenant.
Campos | |
---|---|
parent |
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
|
tenant |
Obrigatório. Inquilino a ser criado. |
DefaultSupportedIdp
Provedores de identidade padrão confiáveis do Identity Toolkit.
Campos | |
---|---|
idp_id |
Identifique o IdP |
description |
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 |
O nome do recurso DefaultSupportedIdpConfig, por exemplo: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com" |
enabled |
Verdadeiro se permite que o usuário faça login com o provedor. |
client_id |
ID do cliente OAuth. |
client_secret |
Chave secreta do cliente OAuth. |
display_on_cloud_console |
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 |
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
|
DeleteInboundSamlConfigRequest
Solicitação para DeleteInboundSamlConfig
Campos | |
---|---|
name |
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
|
DeleteOAuthIdpConfigRequest
Solicitação para DeleteOAuthIdpConfig
Campos | |
---|---|
name |
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
|
DeleteTenantRequest
Mensagem de solicitação para DeleteTenant.
Campos | |
---|---|
name |
Nome do recurso do locatário a ser excluído. A autorização requer a seguinte permissão do IAM no recurso especificado
|
EnableCicpRequest
Solicitação para EnableCicp.
Campos | |
---|---|
project |
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
|
EnableCicpResponse
Esse tipo não tem campos.
Resposta para EnableCicp. Vazio por enquanto.
GetConfigRequest
Solicitação para GetConfig
Campos | |
---|---|
name |
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
|
GetDefaultSupportedIdpConfigRequest
Solicitação para GetDefaultSupportedIdpConfig.
Campos | |
---|---|
name |
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
|
GetInboundSamlConfigRequest
Solicitação de GetInboundSamlConfig
Campos | |
---|---|
name |
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
|
GetOAuthIdpConfigRequest
Solicitação para GetOAuthIdpConfig
Campos | |
---|---|
name |
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
|
GetTenantRequest
Mensagem de solicitação para GetTenant.
Campos | |
---|---|
name |
Nome do recurso do locatário a ser recuperado. A autorização requer a seguinte permissão do IAM no recurso especificado
|
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 |
Apenas saída. Diferentes algoritmos de hash de senha usados no Identity Toolkit. |
signer_key |
Apenas saída. Chave do assinante em base64. |
salt_separator |
Apenas saída. Caractere não imprimível a ser inserido entre o sal e a senha de texto simples em base64. |
rounds |
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 |
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 |
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 |
O nome do recurso InboundSamlConfig, por exemplo: "projects/my-awesome-project/inboundSamlConfigs/my-config-id". Ignorado durante solicitações de criação. |
idp_config |
O proto para armazenar a configuração do IdP (provedor de identidade) SAML quando o projeto atua como parte confiável. |
sp_config |
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 |
O nome de exibição da configuração definido pelos desenvolvedores. |
enabled |
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 |
Identificador exclusivo para todas as entidades SAML. |
sso_url |
URL para enviar a solicitação de autenticação. |
idp_certificates[] |
Chaves públicas do IDP para verificar a assinatura nas declarações. |
sign_request |
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 |
Identificador exclusivo para todas as entidades SAML. |
callback_uri |
URI de callback em que as respostas do IDP são processadas. |
sp_certificates[] |
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 |
O nome do recurso pai, por exemplo, "projects/my-awesome-project". A autorização requer a seguinte permissão do IAM no recurso especificado
|
page_size |
O número máximo de itens para retornar. |
page_token |
O valor next_page_token retornado de uma solicitação List anterior, se houver. |
ListDefaultSupportedIdpConfigsResponse
Resposta para ListDefaultSupportedIdpConfigs
Campos | |
---|---|
default_supported_idp_configs[] |
O conjunto de configurações. |
next_page_token |
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 |
O número máximo de itens para retornar. |
page_token |
O valor next_page_token retornado de uma solicitação List anterior, se houver. |
ListDefaultSupportedIdpsResponse
Resposta para ListDefaultSupportedIdps
Campos | |
---|---|
default_supported_idps[] |
O conjunto de configurações. |
next_page_token |
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 |
O nome do recurso pai, por exemplo, "projects/my-awesome-project". A autorização requer a seguinte permissão do IAM no recurso especificado
|
page_size |
O número máximo de itens para retornar. |
page_token |
O valor next_page_token retornado de uma solicitação List anterior, se houver. |
ListInboundSamlConfigsResponse
Resposta para ListInboundSamlConfigs
Campos | |
---|---|
inbound_saml_configs[] |
O conjunto de configurações. |
next_page_token |
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 |
O nome do recurso pai, por exemplo, "projects/my-awesome-project". A autorização requer a seguinte permissão do IAM no recurso especificado
|
page_size |
O número máximo de itens para retornar. |
page_token |
O valor next_page_token retornado de uma solicitação List anterior, se houver. |
ListOAuthIdpConfigsResponse
Resposta para ListOAuthIdpConfigs
Campos | |
---|---|
oauth_idp_configs[] |
O conjunto de configurações. |
next_page_token |
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 |
Obrigatório. O nome do recurso pai para listar locatários. A autorização requer a seguinte permissão do IAM no recurso especificado
|
page_token |
O token de paginação da resposta de uma solicitação anterior. |
page_size |
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[] |
Uma lista de locatários no projeto do agente. |
next_page_token |
O token para acessar a próxima página de resultados. |
MonitoringConfig
Configuração relacionada ao monitoramento da atividade do projeto.
Campos | |
---|---|
request_logging |
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 |
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 |
Se a autenticação multifator foi ativada para este projeto. |
enabled_providers[] |
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 |
Opções de envio de e-mails. |
send_sms |
Opções para envio de SMS. |
default_locale |
Localidade padrão usada para e-mail e SMS no formato IETF BCP 47. |
SendEmail
Opções de envio de e-mails.
Campos | |
---|---|
method |
O método usado para enviar um e-mail. |
reset_password_template |
Modelo de e-mail para redefinir a senha |
verify_email_template |
Modelo de e-mail para verificar o e-mail |
change_email_template |
Modelo de e-mail para mudança de e-mail |
legacy_reset_password_template |
Modelo de e-mail de redefinição de senha para o app Firebase V1 legado. |
callback_uri |
URL de ação no modelo de e-mail. |
dns_info |
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 |
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 |
Apenas saída. O domínio personalizado verificado aplicado. |
use_custom_domain |
Se é possível usar um domínio personalizado. |
pending_custom_domain |
Apenas saída. O domínio personalizado que será verificado. |
custom_domain_state |
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 |
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 |
Parte local do endereço "De" |
subject |
Assunto do e-mail |
sender_display_name |
Nome de exibição do remetente |
body |
Corpo do e-mail |
body_format |
Formato do corpo do e-mail |
reply_to |
Endereço para resposta |
customized |
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 |
E-mail do remetente para o redirecionamento SMTP |
host |
Host de redirecionamento SMTP |
port |
Porta de redirecionamento SMTP |
username |
Nome de usuário do redirecionamento SMTP |
password |
Senha de redirecionamento SMTP |
security_mode |
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 |
Indica se o cabeçalho accept_language será usado para SMS. |
sms_template |
Apenas saída. O modelo a ser usado ao enviar um SMS. |
SmsTemplate
O modelo a ser usado ao enviar um SMS.
Campos | |
---|---|
content |
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 |
O nome do recurso OAuthIdpConfig, por exemplo: "projects/my-awesome-project/oauthIdpConfigs/oauth-config-id". Ignorado durante solicitações de criação. |
client_id |
O ID do cliente de um cliente OAuth. |
issuer |
Para provedores de identidade do OIDC, o identificador do emissor. |
display_name |
O nome de exibição da configuração definido pelos desenvolvedores. |
enabled |
Verdadeiro se permite que o usuário faça login com o provedor. |
client_secret |
A chave secreta do cliente OAuth, para ativar o fluxo de código do OIDC. |
response_type |
O tipo de resposta a ser solicitado no fluxo de autorização do OAuth. É possível definir |
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 |
Se verdadeiro, o token de ID é retornado do endpoint de autorização do IdP. |
code |
Se for verdadeiro, o código de autorização será retornado do endpoint de autorização do IdP. |
token |
Não use. O tipo de resposta |
QuotaConfig
Configuração relacionada a cotas.
Campos | |
---|---|
sign_up_quota_config |
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 |
Corresponde ao campo "refill_token_count" na configuração do QuotaServer |
start_time |
Quando essa cota vai entrar em vigor |
quota_duration |
Por quanto tempo essa cota vai ficar ativa |
SignInConfig
Configuração relacionada aos métodos de login local.
Campos | |
---|---|
email |
Opções de configuração relacionadas à autenticação de um usuário pelo endereço de e-mail. |
phone_number |
Opções de configuração relacionadas à autenticação de um usuário pelo número de telefone. |
anonymous |
Opções de configuração relacionadas à autenticação de um usuário anônimo. |
allow_duplicate_emails |
Permitir que mais de uma conta tenha o mesmo e-mail. |
hash_config |
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 |
Indica se a autenticação de usuário anônimo está ativada ou não para o projeto. |
Opções de configuração relacionadas à autenticação de um usuário pelo endereço de e-mail.
Campos | |
---|---|
enabled |
Indica se a autenticação de e-mail está ativada ou não para o projeto. |
password_required |
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 |
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 |
Indica se a autenticação de número de telefone está ativada ou não para o projeto. |
test_phone_numbers |
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 |
Certificado público autoassinado. |
expires_at |
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 |
Nome do recurso de um locatário. Por exemplo: "projects/project1/tenants/tenant1" |
display_name |
Nome de exibição do locatário. |
saml_configs[] |
Configurações SAML solicitadas. |
idp_configs[] |
Configurações do IDP solicitadas. |
allow_password_signup |
Define se o registro por e-mail/senha é permitido. |
enable_email_link_signin |
Se o registro por link de e-mail vai ser ativado. |
disable_auth |
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 |
O recurso de configuração que substitui o recurso no servidor. A autorização requer a seguinte permissão do IAM no recurso especificado
|
update_mask |
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 |
UpdateDefaultSupportedIdpConfigRequest
Solicitação para UpdateDefaultSupportedIdpConfig
Campos | |
---|---|
default_supported_idp_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
|
update_mask |
A máscara de atualização aplica-se ao recurso. Para a definição de |
UpdateInboundSamlConfigRequest
Solicitação para UpdateInboundSamlConfig
Campos | |
---|---|
inbound_saml_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
|
update_mask |
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 |
UpdateOAuthIdpConfigRequest
Solicitação para UpdateOAuthIdpConfig
Campos | |
---|---|
oauth_idp_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
|
update_mask |
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 |
UpdateTenantRequest
Mensagem de solicitação para UpdateTenant.
Campos | |
---|---|
tenant |
Obrigatório. Inquilino a ser atualizado. A autorização requer a seguinte permissão do IAM no recurso especificado
|
update_mask |
A máscara de atualização aplica-se ao recurso. Para a definição de |
VerifyDomainRequest
Mensagem de solicitação para verificar se o domínio personalizado solicitado tem os registros DNS necessários.
Campos | |
---|---|
resource |
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
|
domain |
O domínio de destino desta solicitação. |
action |
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 |
O estado resultante do domínio após o processamento da solicitação. |
verification_error |
Quando aplicável, uma explicação textual sobre por que o domínio não foi verificado. |