Method: getPasswordPolicy

Recebe a configuração da política de senha definida no projeto ou locatário.

Solicitação HTTP

GET https://identitytoolkit.googleapis.com/v2/passwordPolicy

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

Parâmetros de consulta

Parâmetros
tenantId

string

O ID de um locatário.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Configuração da política de senha.

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

Representação JSON
{
  "customStrengthOptions": {
    object (CustomStrengthOptions)
  },
  "schemaVersion": integer,
  "allowedNonAlphanumericCharacters": [
    string
  ],
  "enforcementState": enum (EnforcementState),
  "forceUpgradeOnSignin": boolean
}
Campos
customStrengthOptions

object (CustomStrengthOptions)

As opções de nível de segurança personalizadas aplicadas pela política de senha.

schemaVersion

integer

Apenas saída. Número da versão do esquema para a política de senha

allowedNonAlphanumericCharacters[]

string

Apenas saída. Caracteres permitidos que atendem ao requisito não_alfanumérico.

enforcementState

enum (EnforcementState)

Apenas saída. Qual modo de aplicação usar para a política de senha.

forceUpgradeOnSignin

boolean

Os usuários precisam ter uma senha que siga a política de senhas para fazer login.

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.

CustomStrengthOptions

Opções de nível de segurança personalizadas para aplicar às senhas dos usuários.

Representação JSON
{
  "minPasswordLength": integer,
  "maxPasswordLength": integer,
  "containsLowercaseCharacter": boolean,
  "containsUppercaseCharacter": boolean,
  "containsNumericCharacter": boolean,
  "containsNonAlphanumericCharacter": boolean
}
Campos
minPasswordLength

integer

Tamanho mínimo da senha. Varia de 6 a 30

maxPasswordLength

integer

Tamanho máximo da senha. Não há duração máxima padrão

containsLowercaseCharacter

boolean

A senha precisa ter uma letra minúscula.

containsUppercaseCharacter

boolean

A senha precisa ter uma letra maiúscula.

containsNumericCharacter

boolean

A senha precisa conter um número.

containsNonAlphanumericCharacter

boolean

A senha precisa conter um caractere não alfanumérico.

EnforcementState

Estado de aplicação da política de senha

Enums
ENFORCEMENT_STATE_UNSPECIFIED O estado de restrição não foi definido.
OFF A política de senhas não será usada no projeto.
ENFORCE As senhas que não estiverem em compliance com a política de senha serão rejeitadas com um erro.