Identity Toolkit API . v2

Instance Methods

close()

Close httplib2 connections.

getPasswordPolicy(tenantId=None, x__xgafv=None)

Gets password policy config set on the project or tenant.

getRecaptchaConfig(clientType=None, tenantId=None, version=None, x__xgafv=None)

Gets parameters needed for reCAPTCHA analysis.

Method Details

close()
Close httplib2 connections.
getPasswordPolicy(tenantId=None, x__xgafv=None)
Gets password policy config set on the project or tenant.

Args:
  tenantId: string, The id of a tenant.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configuration for password policy.
  "allowedNonAlphanumericCharacters": [ # Output only. Allowed characters which satisfy the non_alphanumeric requirement.
    "A String",
  ],
  "customStrengthOptions": { # Custom strength options to enforce on user passwords. # The custom strength options enforced by the password policy.
    "containsLowercaseCharacter": True or False, # The password must contain a lower case character.
    "containsNonAlphanumericCharacter": True or False, # The password must contain a non alpha numeric character.
    "containsNumericCharacter": True or False, # The password must contain a number.
    "containsUppercaseCharacter": True or False, # The password must contain an upper case character.
    "maxPasswordLength": 42, # Maximum password length. No default max length
    "minPasswordLength": 42, # Minimum password length. Range from 6 to 30
  },
  "enforcementState": "A String", # Output only. Which enforcement mode to use for the password policy.
  "forceUpgradeOnSignin": True or False, # Users must have a password compliant with the password policy to sign-in.
  "schemaVersion": 42, # Output only. schema version number for the password policy
}
getRecaptchaConfig(clientType=None, tenantId=None, version=None, x__xgafv=None)
Gets parameters needed for reCAPTCHA analysis.

Args:
  clientType: string, reCAPTCHA Enterprise uses separate site keys for different client types. Specify the client type to get the corresponding key.
    Allowed values
      CLIENT_TYPE_UNSPECIFIED - Client type is not specified.
      CLIENT_TYPE_WEB - Client type is web.
      CLIENT_TYPE_ANDROID - Client type is android.
      CLIENT_TYPE_IOS - Client type is ios.
  tenantId: string, The id of a tenant.
  version: string, The reCAPTCHA version.
    Allowed values
      RECAPTCHA_VERSION_UNSPECIFIED - The reCAPTCHA version is not specified.
      RECAPTCHA_ENTERPRISE - The reCAPTCHA enterprise.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configuration for reCAPTCHA
  "recaptchaEnforcementState": [ # The reCAPTCHA enforcement state for the providers that GCIP supports reCAPTCHA protection.
    { # Enforcement states for reCAPTCHA protection.
      "enforcementState": "A String", # The reCAPTCHA enforcement state for the provider.
      "provider": "A String", # The provider that has reCAPTCHA protection.
    },
  ],
  "recaptchaKey": "A String", # The reCAPTCHA Enterprise key resource name, e.g. "projects/{project}/keys/{key}". This will only be returned when the reCAPTCHA enforcement state is AUDIT or ENFORCE on at least one of the reCAPTCHA providers.
  "useSmsBotScore": True or False, # Whether to use the rCE bot score for reCAPTCHA phone provider.
  "useSmsTollFraudProtection": True or False, # Whether to use the rCE sms toll fraud protection risk score for reCAPTCHA phone provider.
}