Method: getPasswordPolicy

HTTP request
Query parameters
Request body
Response body
- JSON representation
Authorization scopes
CustomStrengthOptions
- JSON representation
EnforcementState
Try it!

Gets password policy config set on the project or tenant.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters

Parameters
`tenantId`	`string` The id of a tenant.

tenantId

string

The id of a tenant.

Request body

The request body must be empty.

Response body

Configuration for password policy.

If successful, the response body contains data with the following structure:

JSON representation

JSON representation
{ "customStrengthOptions": { object (`CustomStrengthOptions` ) }, "schemaVersion": integer, "allowedNonAlphanumericCharacters": [ string ], "enforcementState": enum (`EnforcementState` ), "forceUpgradeOnSignin": boolean }

{
 "customStrengthOptions": {
 object (CustomStrengthOptions )
 },
 "schemaVersion": integer,
 "allowedNonAlphanumericCharacters": [
 string
 ],
 "enforcementState": enum (EnforcementState ),
 "forceUpgradeOnSignin": boolean
}

Fields
`customStrengthOptions`	`object (CustomStrengthOptions )` The custom strength options enforced by the password policy.
`schemaVersion`	`integer` Output only. schema version number for the password policy
`allowedNonAlphanumericCharacters[]`	`string` Output only. Allowed characters which satisfy the non_alphanumeric requirement.
`enforcementState`	`enum (EnforcementState )` Output only. Which enforcement mode to use for the password policy.
`forceUpgradeOnSignin`	`boolean` Users must have a password compliant with the password policy to sign-in.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

CustomStrengthOptions

Custom strength options to enforce on user passwords.

JSON representation
{ "minPasswordLength": integer, "maxPasswordLength": integer, "containsLowercaseCharacter": boolean, "containsUppercaseCharacter": boolean, "containsNumericCharacter": boolean, "containsNonAlphanumericCharacter": boolean }