File: identitytoolkit_v2.projects.tenants.html

package info (click to toggle)
python-googleapi 2.182.0-1
links: PTS
area: main
in suites: forky, sid
size: 533,852 kB
sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (1059 lines) | stat: -rw-r--r-- 135,019 bytes
parent folder | download | duplicates (2)
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="identitytoolkit_v2.html">Identity Toolkit API</a> . <a href="identitytoolkit_v2.projects.html">projects</a> . <a href="identitytoolkit_v2.projects.tenants.html">tenants</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="identitytoolkit_v2.projects.tenants.defaultSupportedIdpConfigs.html">defaultSupportedIdpConfigs()</a></code>
</p>
<p class="firstline">Returns the defaultSupportedIdpConfigs Resource.</p>

<p class="toc_element">
  <code><a href="identitytoolkit_v2.projects.tenants.inboundSamlConfigs.html">inboundSamlConfigs()</a></code>
</p>
<p class="firstline">Returns the inboundSamlConfigs Resource.</p>

<p class="toc_element">
  <code><a href="identitytoolkit_v2.projects.tenants.oauthIdpConfigs.html">oauthIdpConfigs()</a></code>
</p>
<p class="firstline">Returns the oauthIdpConfigs Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a tenant. Requires write permission on the Agent project.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a tenant. Requires write permission on the Agent project.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get a tenant. Requires read permission on the Tenant resource.</p>
<p class="toc_element">
  <code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a resource. An error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. Caller must have the right Google IAM permission on the resource.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List tenants under the given agent project. Requires read permission on the Agent project.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update a tenant. Requires write permission on the Tenant resource.</p>
<p class="toc_element">
  <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy for a resource. If the policy exists, it is replaced. Caller must have the right Google IAM permission on the resource.</p>
<p class="toc_element">
  <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the caller's permissions on a resource. An error is returned if the resource does not exist. A caller is not required to have Google IAM permission to make this request.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Create a tenant. Requires write permission on the Agent project.

Args:
  parent: string, The parent resource name where the tenant will be created. For example, &quot;projects/project1&quot;. (required)
  body: object, The request body.
    The object takes the form of:

{ # A Tenant contains configuration for the tenant in a multi-tenant project.
  &quot;allowPasswordSignup&quot;: True or False, # Whether to allow email/password user authentication.
  &quot;autodeleteAnonymousUsers&quot;: True or False, # Whether anonymous users will be auto-deleted after a period of 30 days.
  &quot;client&quot;: { # Options related to how clients making requests on behalf of a tenant should be configured. # Options related to how clients making requests on behalf of a project should be configured.
    &quot;permissions&quot;: { # Configuration related to restricting a user&#x27;s ability to affect their account. # Configuration related to restricting a user&#x27;s ability to affect their account.
      &quot;disabledUserDeletion&quot;: True or False, # When true, end users cannot delete their account on the associated project through any of our API methods
      &quot;disabledUserSignup&quot;: True or False, # When true, end users cannot sign up for a new account on the associated project through any of our API methods
    },
  },
  &quot;disableAuth&quot;: True or False, # Whether authentication is disabled for the tenant. If true, the users under the disabled tenant are not allowed to sign-in. Admins of the disabled tenant are not able to manage its users.
  &quot;displayName&quot;: &quot;A String&quot;, # Display name of the tenant.
  &quot;emailPrivacyConfig&quot;: { # Configuration for settings related to email privacy and public visibility. Settings in this config protect against email enumeration, but may make some trade-offs in user-friendliness. # Configuration for settings related to email privacy and public visibility.
    &quot;enableImprovedEmailPrivacy&quot;: True or False, # Migrates the project to a state of improved email privacy. For example certain error codes are more generic to avoid giving away information on whether the account exists. In addition, this disables certain features that as a side-effect allow user enumeration. Enabling this toggle disables the fetchSignInMethodsForEmail functionality and changing the user&#x27;s email to an unverified email. It is recommended to remove dependence on this functionality and enable this toggle to improve user privacy.
  },
  &quot;enableAnonymousUser&quot;: True or False, # Whether to enable anonymous user authentication.
  &quot;enableEmailLinkSignin&quot;: True or False, # Whether to enable email link user authentication.
  &quot;hashConfig&quot;: { # History information of the hash algorithm and key. Different accounts&#x27; passwords may be generated by different version. # Output only. Hash config information of a tenant for display on Pantheon. This can only be displayed on Pantheon to avoid the sensitive information to get accidentally leaked. Only returned in GetTenant response to restrict reading of this information. Requires firebaseauth.configs.getHashConfig permission on the agent project for returning this field.
    &quot;algorithm&quot;: &quot;A String&quot;, # Output only. Different password hash algorithms used in Identity Toolkit.
    &quot;memoryCost&quot;: 42, # Output only. Memory cost for hash calculation. Used by scrypt and other similar password derivation algorithms. See https://tools.ietf.org/html/rfc7914 for explanation of field.
    &quot;rounds&quot;: 42, # Output only. How many rounds for hash calculation. Used by scrypt and other similar password derivation algorithms.
    &quot;saltSeparator&quot;: &quot;A String&quot;, # Output only. Non-printable character to be inserted between the salt and plain text password in base64.
    &quot;signerKey&quot;: &quot;A String&quot;, # Output only. Signer key in base64.
  },
  &quot;inheritance&quot;: { # Settings that the tenants will inherit from project level. # Specify the settings that the tenant could inherit.
    &quot;emailSendingConfig&quot;: True or False, # Whether to allow the tenant to inherit custom domains, email templates, and custom SMTP settings. If true, email sent from tenant will follow the project level email sending configurations. If false (by default), emails will go with the default settings with no customizations.
  },
  &quot;mfaConfig&quot;: { # Options related to MultiFactor Authentication for the project. # The tenant-level configuration of MFA options.
    &quot;enabledProviders&quot;: [ # A list of usable second factors for this project.
      &quot;A String&quot;,
    ],
    &quot;providerConfigs&quot;: [ # A list of usable second factors for this project along with their configurations. This field does not support phone based MFA, for that use the &#x27;enabled_providers&#x27; field.
      { # ProviderConfig describes the supported MFA providers along with their configurations.
        &quot;state&quot;: &quot;A String&quot;, # Describes the state of the MultiFactor Authentication type.
        &quot;totpProviderConfig&quot;: { # TotpMFAProviderConfig represents the TOTP based MFA provider. # TOTP MFA provider config for this project.
          &quot;adjacentIntervals&quot;: 42, # The allowed number of adjacent intervals that will be used for verification to avoid clock skew.
        },
      },
    ],
    &quot;state&quot;: &quot;A String&quot;, # Whether MultiFactor Authentication has been enabled for this project.
  },
  &quot;mobileLinksConfig&quot;: { # Configuration mobile links. # Optional. Deprecated. Never launched. Configuration for settings related to univeral links (iOS) and app links (Android).
    &quot;domain&quot;: &quot;A String&quot;, # Open code in app domain to use for app links and universal links.
  },
  &quot;monitoring&quot;: { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity.
    &quot;requestLogging&quot;: { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging
      &quot;enabled&quot;: True or False, # Whether logging is enabled for this project or not.
    },
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of a tenant. For example: &quot;projects/{project-id}/tenants/{tenant-id}&quot;
  &quot;passwordPolicyConfig&quot;: { # The configuration for the password policy on the project. # The tenant-level password policy config
    &quot;forceUpgradeOnSignin&quot;: True or False, # Users must have a password compliant with the password policy to sign-in.
    &quot;lastUpdateTime&quot;: &quot;A String&quot;, # Output only. The last time the password policy on the project was updated.
    &quot;passwordPolicyEnforcementState&quot;: &quot;A String&quot;, # Which enforcement mode to use for the password policy.
    &quot;passwordPolicyVersions&quot;: [ # Must be of length 1. Contains the strength attributes for the password policy.
      { # The strength attributes for the password policy on the project.
        &quot;customStrengthOptions&quot;: { # Custom strength options to enforce on user passwords. # The custom strength options enforced by the password policy.
          &quot;containsLowercaseCharacter&quot;: True or False, # The password must contain a lower case character.
          &quot;containsNonAlphanumericCharacter&quot;: True or False, # The password must contain a non alpha numeric character.
          &quot;containsNumericCharacter&quot;: True or False, # The password must contain a number.
          &quot;containsUppercaseCharacter&quot;: True or False, # The password must contain an upper case character.
          &quot;maxPasswordLength&quot;: 42, # Maximum password length. No default max length
          &quot;minPasswordLength&quot;: 42, # Minimum password length. Range from 6 to 30
        },
        &quot;schemaVersion&quot;: 42, # Output only. schema version number for the password policy
      },
    ],
  },
  &quot;recaptchaConfig&quot;: { # The reCAPTCHA Enterprise integration config. # The tenant-level reCAPTCHA config.
    &quot;emailPasswordEnforcementState&quot;: &quot;A String&quot;, # The reCAPTCHA config for email/password provider, containing the enforcement status. The email/password provider contains all email related user flows protected by reCAPTCHA.
    &quot;managedRules&quot;: [ # The managed rules for authentication action based on reCAPTCHA scores. The rules are shared across providers for a given tenant project.
      { # The config for a reCAPTCHA managed rule. Models a single interval [start_score, end_score]. The start_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.
        &quot;action&quot;: &quot;A String&quot;, # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].
        &quot;endScore&quot;: 3.14, # The end score (inclusive) of the score range for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the riskiest request (likely a bot), whereas 1.0 indicates the safest request (likely a human). See https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment.
      },
    ],
    &quot;phoneEnforcementState&quot;: &quot;A String&quot;, # The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all SMS related user flows protected by reCAPTCHA.
    &quot;recaptchaKeys&quot;: [ # The reCAPTCHA keys.
      { # The reCAPTCHA key config. reCAPTCHA Enterprise offers different keys for different client platforms.
        &quot;key&quot;: &quot;A String&quot;, # The reCAPTCHA Enterprise key resource name, e.g. &quot;projects/{project}/keys/{key}&quot;
        &quot;type&quot;: &quot;A String&quot;, # The client&#x27;s platform type.
      },
    ],
    &quot;tollFraudManagedRules&quot;: [ # The managed rules for the authentication action based on reCAPTCHA toll fraud risk scores. Toll fraud managed rules will only take effect when the phone_enforcement_state is AUDIT or ENFORCE and use_sms_toll_fraud_protection is true.
      { # The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The end_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.
        &quot;action&quot;: &quot;A String&quot;, # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].
        &quot;startScore&quot;: 3.14, # The start score (inclusive) for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms.
      },
    ],
    &quot;useAccountDefender&quot;: True or False, # Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`.
    &quot;useSmsBotScore&quot;: True or False, # Whether to use the rCE bot score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
    &quot;useSmsTollFraudProtection&quot;: True or False, # Whether to use the rCE sms toll fraud protection risk score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
  },
  &quot;smsRegionConfig&quot;: { # Configures the regions where users are allowed to send verification SMS for the project or tenant. This is based on the calling code of the destination phone number. # Configures which regions are enabled for SMS verification code sending.
    &quot;allowByDefault&quot;: { # Defines a policy of allowing every region by default and adding disallowed regions to a disallow list. # A policy of allowing SMS to every region by default and adding disallowed regions to a disallow list.
      &quot;disallowedRegions&quot;: [ # Two letter unicode region codes to disallow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
        &quot;A String&quot;,
      ],
    },
    &quot;allowlistOnly&quot;: { # Defines a policy of only allowing regions by explicitly adding them to an allowlist. # A policy of only allowing regions by explicitly adding them to an allowlist.
      &quot;allowedRegions&quot;: [ # Two letter unicode region codes to allow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
        &quot;A String&quot;,
      ],
    },
  },
  &quot;testPhoneNumbers&quot;: { # A map of pairs that can be used for MFA. The phone number should be in E.164 format (https://www.itu.int/rec/T-REC-E.164/) and a maximum of 10 pairs can be added (error will be thrown once exceeded).
    &quot;a_key&quot;: &quot;A String&quot;,
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Tenant contains configuration for the tenant in a multi-tenant project.
  &quot;allowPasswordSignup&quot;: True or False, # Whether to allow email/password user authentication.
  &quot;autodeleteAnonymousUsers&quot;: True or False, # Whether anonymous users will be auto-deleted after a period of 30 days.
  &quot;client&quot;: { # Options related to how clients making requests on behalf of a tenant should be configured. # Options related to how clients making requests on behalf of a project should be configured.
    &quot;permissions&quot;: { # Configuration related to restricting a user&#x27;s ability to affect their account. # Configuration related to restricting a user&#x27;s ability to affect their account.
      &quot;disabledUserDeletion&quot;: True or False, # When true, end users cannot delete their account on the associated project through any of our API methods
      &quot;disabledUserSignup&quot;: True or False, # When true, end users cannot sign up for a new account on the associated project through any of our API methods
    },
  },
  &quot;disableAuth&quot;: True or False, # Whether authentication is disabled for the tenant. If true, the users under the disabled tenant are not allowed to sign-in. Admins of the disabled tenant are not able to manage its users.
  &quot;displayName&quot;: &quot;A String&quot;, # Display name of the tenant.
  &quot;emailPrivacyConfig&quot;: { # Configuration for settings related to email privacy and public visibility. Settings in this config protect against email enumeration, but may make some trade-offs in user-friendliness. # Configuration for settings related to email privacy and public visibility.
    &quot;enableImprovedEmailPrivacy&quot;: True or False, # Migrates the project to a state of improved email privacy. For example certain error codes are more generic to avoid giving away information on whether the account exists. In addition, this disables certain features that as a side-effect allow user enumeration. Enabling this toggle disables the fetchSignInMethodsForEmail functionality and changing the user&#x27;s email to an unverified email. It is recommended to remove dependence on this functionality and enable this toggle to improve user privacy.
  },
  &quot;enableAnonymousUser&quot;: True or False, # Whether to enable anonymous user authentication.
  &quot;enableEmailLinkSignin&quot;: True or False, # Whether to enable email link user authentication.
  &quot;hashConfig&quot;: { # History information of the hash algorithm and key. Different accounts&#x27; passwords may be generated by different version. # Output only. Hash config information of a tenant for display on Pantheon. This can only be displayed on Pantheon to avoid the sensitive information to get accidentally leaked. Only returned in GetTenant response to restrict reading of this information. Requires firebaseauth.configs.getHashConfig permission on the agent project for returning this field.
    &quot;algorithm&quot;: &quot;A String&quot;, # Output only. Different password hash algorithms used in Identity Toolkit.
    &quot;memoryCost&quot;: 42, # Output only. Memory cost for hash calculation. Used by scrypt and other similar password derivation algorithms. See https://tools.ietf.org/html/rfc7914 for explanation of field.
    &quot;rounds&quot;: 42, # Output only. How many rounds for hash calculation. Used by scrypt and other similar password derivation algorithms.
    &quot;saltSeparator&quot;: &quot;A String&quot;, # Output only. Non-printable character to be inserted between the salt and plain text password in base64.
    &quot;signerKey&quot;: &quot;A String&quot;, # Output only. Signer key in base64.
  },
  &quot;inheritance&quot;: { # Settings that the tenants will inherit from project level. # Specify the settings that the tenant could inherit.
    &quot;emailSendingConfig&quot;: True or False, # Whether to allow the tenant to inherit custom domains, email templates, and custom SMTP settings. If true, email sent from tenant will follow the project level email sending configurations. If false (by default), emails will go with the default settings with no customizations.
  },
  &quot;mfaConfig&quot;: { # Options related to MultiFactor Authentication for the project. # The tenant-level configuration of MFA options.
    &quot;enabledProviders&quot;: [ # A list of usable second factors for this project.
      &quot;A String&quot;,
    ],
    &quot;providerConfigs&quot;: [ # A list of usable second factors for this project along with their configurations. This field does not support phone based MFA, for that use the &#x27;enabled_providers&#x27; field.
      { # ProviderConfig describes the supported MFA providers along with their configurations.
        &quot;state&quot;: &quot;A String&quot;, # Describes the state of the MultiFactor Authentication type.
        &quot;totpProviderConfig&quot;: { # TotpMFAProviderConfig represents the TOTP based MFA provider. # TOTP MFA provider config for this project.
          &quot;adjacentIntervals&quot;: 42, # The allowed number of adjacent intervals that will be used for verification to avoid clock skew.
        },
      },
    ],
    &quot;state&quot;: &quot;A String&quot;, # Whether MultiFactor Authentication has been enabled for this project.
  },
  &quot;mobileLinksConfig&quot;: { # Configuration mobile links. # Optional. Deprecated. Never launched. Configuration for settings related to univeral links (iOS) and app links (Android).
    &quot;domain&quot;: &quot;A String&quot;, # Open code in app domain to use for app links and universal links.
  },
  &quot;monitoring&quot;: { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity.
    &quot;requestLogging&quot;: { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging
      &quot;enabled&quot;: True or False, # Whether logging is enabled for this project or not.
    },
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of a tenant. For example: &quot;projects/{project-id}/tenants/{tenant-id}&quot;
  &quot;passwordPolicyConfig&quot;: { # The configuration for the password policy on the project. # The tenant-level password policy config
    &quot;forceUpgradeOnSignin&quot;: True or False, # Users must have a password compliant with the password policy to sign-in.
    &quot;lastUpdateTime&quot;: &quot;A String&quot;, # Output only. The last time the password policy on the project was updated.
    &quot;passwordPolicyEnforcementState&quot;: &quot;A String&quot;, # Which enforcement mode to use for the password policy.
    &quot;passwordPolicyVersions&quot;: [ # Must be of length 1. Contains the strength attributes for the password policy.
      { # The strength attributes for the password policy on the project.
        &quot;customStrengthOptions&quot;: { # Custom strength options to enforce on user passwords. # The custom strength options enforced by the password policy.
          &quot;containsLowercaseCharacter&quot;: True or False, # The password must contain a lower case character.
          &quot;containsNonAlphanumericCharacter&quot;: True or False, # The password must contain a non alpha numeric character.
          &quot;containsNumericCharacter&quot;: True or False, # The password must contain a number.
          &quot;containsUppercaseCharacter&quot;: True or False, # The password must contain an upper case character.
          &quot;maxPasswordLength&quot;: 42, # Maximum password length. No default max length
          &quot;minPasswordLength&quot;: 42, # Minimum password length. Range from 6 to 30
        },
        &quot;schemaVersion&quot;: 42, # Output only. schema version number for the password policy
      },
    ],
  },
  &quot;recaptchaConfig&quot;: { # The reCAPTCHA Enterprise integration config. # The tenant-level reCAPTCHA config.
    &quot;emailPasswordEnforcementState&quot;: &quot;A String&quot;, # The reCAPTCHA config for email/password provider, containing the enforcement status. The email/password provider contains all email related user flows protected by reCAPTCHA.
    &quot;managedRules&quot;: [ # The managed rules for authentication action based on reCAPTCHA scores. The rules are shared across providers for a given tenant project.
      { # The config for a reCAPTCHA managed rule. Models a single interval [start_score, end_score]. The start_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.
        &quot;action&quot;: &quot;A String&quot;, # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].
        &quot;endScore&quot;: 3.14, # The end score (inclusive) of the score range for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the riskiest request (likely a bot), whereas 1.0 indicates the safest request (likely a human). See https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment.
      },
    ],
    &quot;phoneEnforcementState&quot;: &quot;A String&quot;, # The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all SMS related user flows protected by reCAPTCHA.
    &quot;recaptchaKeys&quot;: [ # The reCAPTCHA keys.
      { # The reCAPTCHA key config. reCAPTCHA Enterprise offers different keys for different client platforms.
        &quot;key&quot;: &quot;A String&quot;, # The reCAPTCHA Enterprise key resource name, e.g. &quot;projects/{project}/keys/{key}&quot;
        &quot;type&quot;: &quot;A String&quot;, # The client&#x27;s platform type.
      },
    ],
    &quot;tollFraudManagedRules&quot;: [ # The managed rules for the authentication action based on reCAPTCHA toll fraud risk scores. Toll fraud managed rules will only take effect when the phone_enforcement_state is AUDIT or ENFORCE and use_sms_toll_fraud_protection is true.
      { # The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The end_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.
        &quot;action&quot;: &quot;A String&quot;, # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].
        &quot;startScore&quot;: 3.14, # The start score (inclusive) for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms.
      },
    ],
    &quot;useAccountDefender&quot;: True or False, # Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`.
    &quot;useSmsBotScore&quot;: True or False, # Whether to use the rCE bot score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
    &quot;useSmsTollFraudProtection&quot;: True or False, # Whether to use the rCE sms toll fraud protection risk score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
  },
  &quot;smsRegionConfig&quot;: { # Configures the regions where users are allowed to send verification SMS for the project or tenant. This is based on the calling code of the destination phone number. # Configures which regions are enabled for SMS verification code sending.
    &quot;allowByDefault&quot;: { # Defines a policy of allowing every region by default and adding disallowed regions to a disallow list. # A policy of allowing SMS to every region by default and adding disallowed regions to a disallow list.
      &quot;disallowedRegions&quot;: [ # Two letter unicode region codes to disallow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
        &quot;A String&quot;,
      ],
    },
    &quot;allowlistOnly&quot;: { # Defines a policy of only allowing regions by explicitly adding them to an allowlist. # A policy of only allowing regions by explicitly adding them to an allowlist.
      &quot;allowedRegions&quot;: [ # Two letter unicode region codes to allow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
        &quot;A String&quot;,
      ],
    },
  },
  &quot;testPhoneNumbers&quot;: { # A map of pairs that can be used for MFA. The phone number should be in E.164 format (https://www.itu.int/rec/T-REC-E.164/) and a maximum of 10 pairs can be added (error will be thrown once exceeded).
    &quot;a_key&quot;: &quot;A String&quot;,
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Delete a tenant. Requires write permission on the Agent project.

Args:
  name: string, Resource name of the tenant to delete. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Get a tenant. Requires read permission on the Tenant resource.

Args:
  name: string, Resource name of the tenant to retrieve. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Tenant contains configuration for the tenant in a multi-tenant project.
  &quot;allowPasswordSignup&quot;: True or False, # Whether to allow email/password user authentication.
  &quot;autodeleteAnonymousUsers&quot;: True or False, # Whether anonymous users will be auto-deleted after a period of 30 days.
  &quot;client&quot;: { # Options related to how clients making requests on behalf of a tenant should be configured. # Options related to how clients making requests on behalf of a project should be configured.
    &quot;permissions&quot;: { # Configuration related to restricting a user&#x27;s ability to affect their account. # Configuration related to restricting a user&#x27;s ability to affect their account.
      &quot;disabledUserDeletion&quot;: True or False, # When true, end users cannot delete their account on the associated project through any of our API methods
      &quot;disabledUserSignup&quot;: True or False, # When true, end users cannot sign up for a new account on the associated project through any of our API methods
    },
  },
  &quot;disableAuth&quot;: True or False, # Whether authentication is disabled for the tenant. If true, the users under the disabled tenant are not allowed to sign-in. Admins of the disabled tenant are not able to manage its users.
  &quot;displayName&quot;: &quot;A String&quot;, # Display name of the tenant.
  &quot;emailPrivacyConfig&quot;: { # Configuration for settings related to email privacy and public visibility. Settings in this config protect against email enumeration, but may make some trade-offs in user-friendliness. # Configuration for settings related to email privacy and public visibility.
    &quot;enableImprovedEmailPrivacy&quot;: True or False, # Migrates the project to a state of improved email privacy. For example certain error codes are more generic to avoid giving away information on whether the account exists. In addition, this disables certain features that as a side-effect allow user enumeration. Enabling this toggle disables the fetchSignInMethodsForEmail functionality and changing the user&#x27;s email to an unverified email. It is recommended to remove dependence on this functionality and enable this toggle to improve user privacy.
  },
  &quot;enableAnonymousUser&quot;: True or False, # Whether to enable anonymous user authentication.
  &quot;enableEmailLinkSignin&quot;: True or False, # Whether to enable email link user authentication.
  &quot;hashConfig&quot;: { # History information of the hash algorithm and key. Different accounts&#x27; passwords may be generated by different version. # Output only. Hash config information of a tenant for display on Pantheon. This can only be displayed on Pantheon to avoid the sensitive information to get accidentally leaked. Only returned in GetTenant response to restrict reading of this information. Requires firebaseauth.configs.getHashConfig permission on the agent project for returning this field.
    &quot;algorithm&quot;: &quot;A String&quot;, # Output only. Different password hash algorithms used in Identity Toolkit.
    &quot;memoryCost&quot;: 42, # Output only. Memory cost for hash calculation. Used by scrypt and other similar password derivation algorithms. See https://tools.ietf.org/html/rfc7914 for explanation of field.
    &quot;rounds&quot;: 42, # Output only. How many rounds for hash calculation. Used by scrypt and other similar password derivation algorithms.
    &quot;saltSeparator&quot;: &quot;A String&quot;, # Output only. Non-printable character to be inserted between the salt and plain text password in base64.
    &quot;signerKey&quot;: &quot;A String&quot;, # Output only. Signer key in base64.
  },
  &quot;inheritance&quot;: { # Settings that the tenants will inherit from project level. # Specify the settings that the tenant could inherit.
    &quot;emailSendingConfig&quot;: True or False, # Whether to allow the tenant to inherit custom domains, email templates, and custom SMTP settings. If true, email sent from tenant will follow the project level email sending configurations. If false (by default), emails will go with the default settings with no customizations.
  },
  &quot;mfaConfig&quot;: { # Options related to MultiFactor Authentication for the project. # The tenant-level configuration of MFA options.
    &quot;enabledProviders&quot;: [ # A list of usable second factors for this project.
      &quot;A String&quot;,
    ],
    &quot;providerConfigs&quot;: [ # A list of usable second factors for this project along with their configurations. This field does not support phone based MFA, for that use the &#x27;enabled_providers&#x27; field.
      { # ProviderConfig describes the supported MFA providers along with their configurations.
        &quot;state&quot;: &quot;A String&quot;, # Describes the state of the MultiFactor Authentication type.
        &quot;totpProviderConfig&quot;: { # TotpMFAProviderConfig represents the TOTP based MFA provider. # TOTP MFA provider config for this project.
          &quot;adjacentIntervals&quot;: 42, # The allowed number of adjacent intervals that will be used for verification to avoid clock skew.
        },
      },
    ],
    &quot;state&quot;: &quot;A String&quot;, # Whether MultiFactor Authentication has been enabled for this project.
  },
  &quot;mobileLinksConfig&quot;: { # Configuration mobile links. # Optional. Deprecated. Never launched. Configuration for settings related to univeral links (iOS) and app links (Android).
    &quot;domain&quot;: &quot;A String&quot;, # Open code in app domain to use for app links and universal links.
  },
  &quot;monitoring&quot;: { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity.
    &quot;requestLogging&quot;: { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging
      &quot;enabled&quot;: True or False, # Whether logging is enabled for this project or not.
    },
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of a tenant. For example: &quot;projects/{project-id}/tenants/{tenant-id}&quot;
  &quot;passwordPolicyConfig&quot;: { # The configuration for the password policy on the project. # The tenant-level password policy config
    &quot;forceUpgradeOnSignin&quot;: True or False, # Users must have a password compliant with the password policy to sign-in.
    &quot;lastUpdateTime&quot;: &quot;A String&quot;, # Output only. The last time the password policy on the project was updated.
    &quot;passwordPolicyEnforcementState&quot;: &quot;A String&quot;, # Which enforcement mode to use for the password policy.
    &quot;passwordPolicyVersions&quot;: [ # Must be of length 1. Contains the strength attributes for the password policy.
      { # The strength attributes for the password policy on the project.
        &quot;customStrengthOptions&quot;: { # Custom strength options to enforce on user passwords. # The custom strength options enforced by the password policy.
          &quot;containsLowercaseCharacter&quot;: True or False, # The password must contain a lower case character.
          &quot;containsNonAlphanumericCharacter&quot;: True or False, # The password must contain a non alpha numeric character.
          &quot;containsNumericCharacter&quot;: True or False, # The password must contain a number.
          &quot;containsUppercaseCharacter&quot;: True or False, # The password must contain an upper case character.
          &quot;maxPasswordLength&quot;: 42, # Maximum password length. No default max length
          &quot;minPasswordLength&quot;: 42, # Minimum password length. Range from 6 to 30
        },
        &quot;schemaVersion&quot;: 42, # Output only. schema version number for the password policy
      },
    ],
  },
  &quot;recaptchaConfig&quot;: { # The reCAPTCHA Enterprise integration config. # The tenant-level reCAPTCHA config.
    &quot;emailPasswordEnforcementState&quot;: &quot;A String&quot;, # The reCAPTCHA config for email/password provider, containing the enforcement status. The email/password provider contains all email related user flows protected by reCAPTCHA.
    &quot;managedRules&quot;: [ # The managed rules for authentication action based on reCAPTCHA scores. The rules are shared across providers for a given tenant project.
      { # The config for a reCAPTCHA managed rule. Models a single interval [start_score, end_score]. The start_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.
        &quot;action&quot;: &quot;A String&quot;, # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].
        &quot;endScore&quot;: 3.14, # The end score (inclusive) of the score range for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the riskiest request (likely a bot), whereas 1.0 indicates the safest request (likely a human). See https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment.
      },
    ],
    &quot;phoneEnforcementState&quot;: &quot;A String&quot;, # The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all SMS related user flows protected by reCAPTCHA.
    &quot;recaptchaKeys&quot;: [ # The reCAPTCHA keys.
      { # The reCAPTCHA key config. reCAPTCHA Enterprise offers different keys for different client platforms.
        &quot;key&quot;: &quot;A String&quot;, # The reCAPTCHA Enterprise key resource name, e.g. &quot;projects/{project}/keys/{key}&quot;
        &quot;type&quot;: &quot;A String&quot;, # The client&#x27;s platform type.
      },
    ],
    &quot;tollFraudManagedRules&quot;: [ # The managed rules for the authentication action based on reCAPTCHA toll fraud risk scores. Toll fraud managed rules will only take effect when the phone_enforcement_state is AUDIT or ENFORCE and use_sms_toll_fraud_protection is true.
      { # The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The end_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.
        &quot;action&quot;: &quot;A String&quot;, # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].
        &quot;startScore&quot;: 3.14, # The start score (inclusive) for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms.
      },
    ],
    &quot;useAccountDefender&quot;: True or False, # Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`.
    &quot;useSmsBotScore&quot;: True or False, # Whether to use the rCE bot score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
    &quot;useSmsTollFraudProtection&quot;: True or False, # Whether to use the rCE sms toll fraud protection risk score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
  },
  &quot;smsRegionConfig&quot;: { # Configures the regions where users are allowed to send verification SMS for the project or tenant. This is based on the calling code of the destination phone number. # Configures which regions are enabled for SMS verification code sending.
    &quot;allowByDefault&quot;: { # Defines a policy of allowing every region by default and adding disallowed regions to a disallow list. # A policy of allowing SMS to every region by default and adding disallowed regions to a disallow list.
      &quot;disallowedRegions&quot;: [ # Two letter unicode region codes to disallow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
        &quot;A String&quot;,
      ],
    },
    &quot;allowlistOnly&quot;: { # Defines a policy of only allowing regions by explicitly adding them to an allowlist. # A policy of only allowing regions by explicitly adding them to an allowlist.
      &quot;allowedRegions&quot;: [ # Two letter unicode region codes to allow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
        &quot;A String&quot;,
      ],
    },
  },
  &quot;testPhoneNumbers&quot;: { # A map of pairs that can be used for MFA. The phone number should be in E.164 format (https://www.itu.int/rec/T-REC-E.164/) and a maximum of 10 pairs can be added (error will be thrown once exceeded).
    &quot;a_key&quot;: &quot;A String&quot;,
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
  <pre>Gets the access control policy for a resource. An error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. Caller must have the right Google IAM permission on the resource.

Args:
  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for `GetIamPolicy` method.
  &quot;options&quot;: { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
    &quot;requestedPolicyVersion&quot;: 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
  &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
      &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
        { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
          &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
            &quot;A String&quot;,
          ],
          &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
        },
      ],
      &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
    },
  ],
  &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
    { # Associates `members`, or principals, with a `role`.
      &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
        &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
        &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
        &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
        &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
      },
      &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
        &quot;A String&quot;,
      ],
      &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
    },
  ],
  &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
  &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>List tenants under the given agent project. Requires read permission on the Agent project.

Args:
  parent: string, Required. The parent resource name to list tenants for. (required)
  pageSize: integer, The maximum number of results to return, capped at 1000. If not specified, the default value is 20.
  pageToken: string, The pagination token from the response of a previous request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ListTenants.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # The token to get the next page of results.
  &quot;tenants&quot;: [ # A list of tenants under the given agent project.
    { # A Tenant contains configuration for the tenant in a multi-tenant project.
      &quot;allowPasswordSignup&quot;: True or False, # Whether to allow email/password user authentication.
      &quot;autodeleteAnonymousUsers&quot;: True or False, # Whether anonymous users will be auto-deleted after a period of 30 days.
      &quot;client&quot;: { # Options related to how clients making requests on behalf of a tenant should be configured. # Options related to how clients making requests on behalf of a project should be configured.
        &quot;permissions&quot;: { # Configuration related to restricting a user&#x27;s ability to affect their account. # Configuration related to restricting a user&#x27;s ability to affect their account.
          &quot;disabledUserDeletion&quot;: True or False, # When true, end users cannot delete their account on the associated project through any of our API methods
          &quot;disabledUserSignup&quot;: True or False, # When true, end users cannot sign up for a new account on the associated project through any of our API methods
        },
      },
      &quot;disableAuth&quot;: True or False, # Whether authentication is disabled for the tenant. If true, the users under the disabled tenant are not allowed to sign-in. Admins of the disabled tenant are not able to manage its users.
      &quot;displayName&quot;: &quot;A String&quot;, # Display name of the tenant.
      &quot;emailPrivacyConfig&quot;: { # Configuration for settings related to email privacy and public visibility. Settings in this config protect against email enumeration, but may make some trade-offs in user-friendliness. # Configuration for settings related to email privacy and public visibility.
        &quot;enableImprovedEmailPrivacy&quot;: True or False, # Migrates the project to a state of improved email privacy. For example certain error codes are more generic to avoid giving away information on whether the account exists. In addition, this disables certain features that as a side-effect allow user enumeration. Enabling this toggle disables the fetchSignInMethodsForEmail functionality and changing the user&#x27;s email to an unverified email. It is recommended to remove dependence on this functionality and enable this toggle to improve user privacy.
      },
      &quot;enableAnonymousUser&quot;: True or False, # Whether to enable anonymous user authentication.
      &quot;enableEmailLinkSignin&quot;: True or False, # Whether to enable email link user authentication.
      &quot;hashConfig&quot;: { # History information of the hash algorithm and key. Different accounts&#x27; passwords may be generated by different version. # Output only. Hash config information of a tenant for display on Pantheon. This can only be displayed on Pantheon to avoid the sensitive information to get accidentally leaked. Only returned in GetTenant response to restrict reading of this information. Requires firebaseauth.configs.getHashConfig permission on the agent project for returning this field.
        &quot;algorithm&quot;: &quot;A String&quot;, # Output only. Different password hash algorithms used in Identity Toolkit.
        &quot;memoryCost&quot;: 42, # Output only. Memory cost for hash calculation. Used by scrypt and other similar password derivation algorithms. See https://tools.ietf.org/html/rfc7914 for explanation of field.
        &quot;rounds&quot;: 42, # Output only. How many rounds for hash calculation. Used by scrypt and other similar password derivation algorithms.
        &quot;saltSeparator&quot;: &quot;A String&quot;, # Output only. Non-printable character to be inserted between the salt and plain text password in base64.
        &quot;signerKey&quot;: &quot;A String&quot;, # Output only. Signer key in base64.
      },
      &quot;inheritance&quot;: { # Settings that the tenants will inherit from project level. # Specify the settings that the tenant could inherit.
        &quot;emailSendingConfig&quot;: True or False, # Whether to allow the tenant to inherit custom domains, email templates, and custom SMTP settings. If true, email sent from tenant will follow the project level email sending configurations. If false (by default), emails will go with the default settings with no customizations.
      },
      &quot;mfaConfig&quot;: { # Options related to MultiFactor Authentication for the project. # The tenant-level configuration of MFA options.
        &quot;enabledProviders&quot;: [ # A list of usable second factors for this project.
          &quot;A String&quot;,
        ],
        &quot;providerConfigs&quot;: [ # A list of usable second factors for this project along with their configurations. This field does not support phone based MFA, for that use the &#x27;enabled_providers&#x27; field.
          { # ProviderConfig describes the supported MFA providers along with their configurations.
            &quot;state&quot;: &quot;A String&quot;, # Describes the state of the MultiFactor Authentication type.
            &quot;totpProviderConfig&quot;: { # TotpMFAProviderConfig represents the TOTP based MFA provider. # TOTP MFA provider config for this project.
              &quot;adjacentIntervals&quot;: 42, # The allowed number of adjacent intervals that will be used for verification to avoid clock skew.
            },
          },
        ],
        &quot;state&quot;: &quot;A String&quot;, # Whether MultiFactor Authentication has been enabled for this project.
      },
      &quot;mobileLinksConfig&quot;: { # Configuration mobile links. # Optional. Deprecated. Never launched. Configuration for settings related to univeral links (iOS) and app links (Android).
        &quot;domain&quot;: &quot;A String&quot;, # Open code in app domain to use for app links and universal links.
      },
      &quot;monitoring&quot;: { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity.
        &quot;requestLogging&quot;: { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging
          &quot;enabled&quot;: True or False, # Whether logging is enabled for this project or not.
        },
      },
      &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of a tenant. For example: &quot;projects/{project-id}/tenants/{tenant-id}&quot;
      &quot;passwordPolicyConfig&quot;: { # The configuration for the password policy on the project. # The tenant-level password policy config
        &quot;forceUpgradeOnSignin&quot;: True or False, # Users must have a password compliant with the password policy to sign-in.
        &quot;lastUpdateTime&quot;: &quot;A String&quot;, # Output only. The last time the password policy on the project was updated.
        &quot;passwordPolicyEnforcementState&quot;: &quot;A String&quot;, # Which enforcement mode to use for the password policy.
        &quot;passwordPolicyVersions&quot;: [ # Must be of length 1. Contains the strength attributes for the password policy.
          { # The strength attributes for the password policy on the project.
            &quot;customStrengthOptions&quot;: { # Custom strength options to enforce on user passwords. # The custom strength options enforced by the password policy.
              &quot;containsLowercaseCharacter&quot;: True or False, # The password must contain a lower case character.
              &quot;containsNonAlphanumericCharacter&quot;: True or False, # The password must contain a non alpha numeric character.
              &quot;containsNumericCharacter&quot;: True or False, # The password must contain a number.
              &quot;containsUppercaseCharacter&quot;: True or False, # The password must contain an upper case character.
              &quot;maxPasswordLength&quot;: 42, # Maximum password length. No default max length
              &quot;minPasswordLength&quot;: 42, # Minimum password length. Range from 6 to 30
            },
            &quot;schemaVersion&quot;: 42, # Output only. schema version number for the password policy
          },
        ],
      },
      &quot;recaptchaConfig&quot;: { # The reCAPTCHA Enterprise integration config. # The tenant-level reCAPTCHA config.
        &quot;emailPasswordEnforcementState&quot;: &quot;A String&quot;, # The reCAPTCHA config for email/password provider, containing the enforcement status. The email/password provider contains all email related user flows protected by reCAPTCHA.
        &quot;managedRules&quot;: [ # The managed rules for authentication action based on reCAPTCHA scores. The rules are shared across providers for a given tenant project.
          { # The config for a reCAPTCHA managed rule. Models a single interval [start_score, end_score]. The start_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.
            &quot;action&quot;: &quot;A String&quot;, # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].
            &quot;endScore&quot;: 3.14, # The end score (inclusive) of the score range for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the riskiest request (likely a bot), whereas 1.0 indicates the safest request (likely a human). See https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment.
          },
        ],
        &quot;phoneEnforcementState&quot;: &quot;A String&quot;, # The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all SMS related user flows protected by reCAPTCHA.
        &quot;recaptchaKeys&quot;: [ # The reCAPTCHA keys.
          { # The reCAPTCHA key config. reCAPTCHA Enterprise offers different keys for different client platforms.
            &quot;key&quot;: &quot;A String&quot;, # The reCAPTCHA Enterprise key resource name, e.g. &quot;projects/{project}/keys/{key}&quot;
            &quot;type&quot;: &quot;A String&quot;, # The client&#x27;s platform type.
          },
        ],
        &quot;tollFraudManagedRules&quot;: [ # The managed rules for the authentication action based on reCAPTCHA toll fraud risk scores. Toll fraud managed rules will only take effect when the phone_enforcement_state is AUDIT or ENFORCE and use_sms_toll_fraud_protection is true.
          { # The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The end_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.
            &quot;action&quot;: &quot;A String&quot;, # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].
            &quot;startScore&quot;: 3.14, # The start score (inclusive) for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms.
          },
        ],
        &quot;useAccountDefender&quot;: True or False, # Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`.
        &quot;useSmsBotScore&quot;: True or False, # Whether to use the rCE bot score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
        &quot;useSmsTollFraudProtection&quot;: True or False, # Whether to use the rCE sms toll fraud protection risk score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
      },
      &quot;smsRegionConfig&quot;: { # Configures the regions where users are allowed to send verification SMS for the project or tenant. This is based on the calling code of the destination phone number. # Configures which regions are enabled for SMS verification code sending.
        &quot;allowByDefault&quot;: { # Defines a policy of allowing every region by default and adding disallowed regions to a disallow list. # A policy of allowing SMS to every region by default and adding disallowed regions to a disallow list.
          &quot;disallowedRegions&quot;: [ # Two letter unicode region codes to disallow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
            &quot;A String&quot;,
          ],
        },
        &quot;allowlistOnly&quot;: { # Defines a policy of only allowing regions by explicitly adding them to an allowlist. # A policy of only allowing regions by explicitly adding them to an allowlist.
          &quot;allowedRegions&quot;: [ # Two letter unicode region codes to allow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
            &quot;A String&quot;,
          ],
        },
      },
      &quot;testPhoneNumbers&quot;: { # A map of pairs that can be used for MFA. The phone number should be in E.164 format (https://www.itu.int/rec/T-REC-E.164/) and a maximum of 10 pairs can be added (error will be thrown once exceeded).
        &quot;a_key&quot;: &quot;A String&quot;,
      },
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Update a tenant. Requires write permission on the Tenant resource.

Args:
  name: string, Output only. Resource name of a tenant. For example: &quot;projects/{project-id}/tenants/{tenant-id}&quot; (required)
  body: object, The request body.
    The object takes the form of:

{ # A Tenant contains configuration for the tenant in a multi-tenant project.
  &quot;allowPasswordSignup&quot;: True or False, # Whether to allow email/password user authentication.
  &quot;autodeleteAnonymousUsers&quot;: True or False, # Whether anonymous users will be auto-deleted after a period of 30 days.
  &quot;client&quot;: { # Options related to how clients making requests on behalf of a tenant should be configured. # Options related to how clients making requests on behalf of a project should be configured.
    &quot;permissions&quot;: { # Configuration related to restricting a user&#x27;s ability to affect their account. # Configuration related to restricting a user&#x27;s ability to affect their account.
      &quot;disabledUserDeletion&quot;: True or False, # When true, end users cannot delete their account on the associated project through any of our API methods
      &quot;disabledUserSignup&quot;: True or False, # When true, end users cannot sign up for a new account on the associated project through any of our API methods
    },
  },
  &quot;disableAuth&quot;: True or False, # Whether authentication is disabled for the tenant. If true, the users under the disabled tenant are not allowed to sign-in. Admins of the disabled tenant are not able to manage its users.
  &quot;displayName&quot;: &quot;A String&quot;, # Display name of the tenant.
  &quot;emailPrivacyConfig&quot;: { # Configuration for settings related to email privacy and public visibility. Settings in this config protect against email enumeration, but may make some trade-offs in user-friendliness. # Configuration for settings related to email privacy and public visibility.
    &quot;enableImprovedEmailPrivacy&quot;: True or False, # Migrates the project to a state of improved email privacy. For example certain error codes are more generic to avoid giving away information on whether the account exists. In addition, this disables certain features that as a side-effect allow user enumeration. Enabling this toggle disables the fetchSignInMethodsForEmail functionality and changing the user&#x27;s email to an unverified email. It is recommended to remove dependence on this functionality and enable this toggle to improve user privacy.
  },
  &quot;enableAnonymousUser&quot;: True or False, # Whether to enable anonymous user authentication.
  &quot;enableEmailLinkSignin&quot;: True or False, # Whether to enable email link user authentication.
  &quot;hashConfig&quot;: { # History information of the hash algorithm and key. Different accounts&#x27; passwords may be generated by different version. # Output only. Hash config information of a tenant for display on Pantheon. This can only be displayed on Pantheon to avoid the sensitive information to get accidentally leaked. Only returned in GetTenant response to restrict reading of this information. Requires firebaseauth.configs.getHashConfig permission on the agent project for returning this field.
    &quot;algorithm&quot;: &quot;A String&quot;, # Output only. Different password hash algorithms used in Identity Toolkit.
    &quot;memoryCost&quot;: 42, # Output only. Memory cost for hash calculation. Used by scrypt and other similar password derivation algorithms. See https://tools.ietf.org/html/rfc7914 for explanation of field.
    &quot;rounds&quot;: 42, # Output only. How many rounds for hash calculation. Used by scrypt and other similar password derivation algorithms.
    &quot;saltSeparator&quot;: &quot;A String&quot;, # Output only. Non-printable character to be inserted between the salt and plain text password in base64.
    &quot;signerKey&quot;: &quot;A String&quot;, # Output only. Signer key in base64.
  },
  &quot;inheritance&quot;: { # Settings that the tenants will inherit from project level. # Specify the settings that the tenant could inherit.
    &quot;emailSendingConfig&quot;: True or False, # Whether to allow the tenant to inherit custom domains, email templates, and custom SMTP settings. If true, email sent from tenant will follow the project level email sending configurations. If false (by default), emails will go with the default settings with no customizations.
  },
  &quot;mfaConfig&quot;: { # Options related to MultiFactor Authentication for the project. # The tenant-level configuration of MFA options.
    &quot;enabledProviders&quot;: [ # A list of usable second factors for this project.
      &quot;A String&quot;,
    ],
    &quot;providerConfigs&quot;: [ # A list of usable second factors for this project along with their configurations. This field does not support phone based MFA, for that use the &#x27;enabled_providers&#x27; field.
      { # ProviderConfig describes the supported MFA providers along with their configurations.
        &quot;state&quot;: &quot;A String&quot;, # Describes the state of the MultiFactor Authentication type.
        &quot;totpProviderConfig&quot;: { # TotpMFAProviderConfig represents the TOTP based MFA provider. # TOTP MFA provider config for this project.
          &quot;adjacentIntervals&quot;: 42, # The allowed number of adjacent intervals that will be used for verification to avoid clock skew.
        },
      },
    ],
    &quot;state&quot;: &quot;A String&quot;, # Whether MultiFactor Authentication has been enabled for this project.
  },
  &quot;mobileLinksConfig&quot;: { # Configuration mobile links. # Optional. Deprecated. Never launched. Configuration for settings related to univeral links (iOS) and app links (Android).
    &quot;domain&quot;: &quot;A String&quot;, # Open code in app domain to use for app links and universal links.
  },
  &quot;monitoring&quot;: { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity.
    &quot;requestLogging&quot;: { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging
      &quot;enabled&quot;: True or False, # Whether logging is enabled for this project or not.
    },
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of a tenant. For example: &quot;projects/{project-id}/tenants/{tenant-id}&quot;
  &quot;passwordPolicyConfig&quot;: { # The configuration for the password policy on the project. # The tenant-level password policy config
    &quot;forceUpgradeOnSignin&quot;: True or False, # Users must have a password compliant with the password policy to sign-in.
    &quot;lastUpdateTime&quot;: &quot;A String&quot;, # Output only. The last time the password policy on the project was updated.
    &quot;passwordPolicyEnforcementState&quot;: &quot;A String&quot;, # Which enforcement mode to use for the password policy.
    &quot;passwordPolicyVersions&quot;: [ # Must be of length 1. Contains the strength attributes for the password policy.
      { # The strength attributes for the password policy on the project.
        &quot;customStrengthOptions&quot;: { # Custom strength options to enforce on user passwords. # The custom strength options enforced by the password policy.
          &quot;containsLowercaseCharacter&quot;: True or False, # The password must contain a lower case character.
          &quot;containsNonAlphanumericCharacter&quot;: True or False, # The password must contain a non alpha numeric character.
          &quot;containsNumericCharacter&quot;: True or False, # The password must contain a number.
          &quot;containsUppercaseCharacter&quot;: True or False, # The password must contain an upper case character.
          &quot;maxPasswordLength&quot;: 42, # Maximum password length. No default max length
          &quot;minPasswordLength&quot;: 42, # Minimum password length. Range from 6 to 30
        },
        &quot;schemaVersion&quot;: 42, # Output only. schema version number for the password policy
      },
    ],
  },
  &quot;recaptchaConfig&quot;: { # The reCAPTCHA Enterprise integration config. # The tenant-level reCAPTCHA config.
    &quot;emailPasswordEnforcementState&quot;: &quot;A String&quot;, # The reCAPTCHA config for email/password provider, containing the enforcement status. The email/password provider contains all email related user flows protected by reCAPTCHA.
    &quot;managedRules&quot;: [ # The managed rules for authentication action based on reCAPTCHA scores. The rules are shared across providers for a given tenant project.
      { # The config for a reCAPTCHA managed rule. Models a single interval [start_score, end_score]. The start_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.
        &quot;action&quot;: &quot;A String&quot;, # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].
        &quot;endScore&quot;: 3.14, # The end score (inclusive) of the score range for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the riskiest request (likely a bot), whereas 1.0 indicates the safest request (likely a human). See https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment.
      },
    ],
    &quot;phoneEnforcementState&quot;: &quot;A String&quot;, # The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all SMS related user flows protected by reCAPTCHA.
    &quot;recaptchaKeys&quot;: [ # The reCAPTCHA keys.
      { # The reCAPTCHA key config. reCAPTCHA Enterprise offers different keys for different client platforms.
        &quot;key&quot;: &quot;A String&quot;, # The reCAPTCHA Enterprise key resource name, e.g. &quot;projects/{project}/keys/{key}&quot;
        &quot;type&quot;: &quot;A String&quot;, # The client&#x27;s platform type.
      },
    ],
    &quot;tollFraudManagedRules&quot;: [ # The managed rules for the authentication action based on reCAPTCHA toll fraud risk scores. Toll fraud managed rules will only take effect when the phone_enforcement_state is AUDIT or ENFORCE and use_sms_toll_fraud_protection is true.
      { # The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The end_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.
        &quot;action&quot;: &quot;A String&quot;, # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].
        &quot;startScore&quot;: 3.14, # The start score (inclusive) for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms.
      },
    ],
    &quot;useAccountDefender&quot;: True or False, # Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`.
    &quot;useSmsBotScore&quot;: True or False, # Whether to use the rCE bot score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
    &quot;useSmsTollFraudProtection&quot;: True or False, # Whether to use the rCE sms toll fraud protection risk score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
  },
  &quot;smsRegionConfig&quot;: { # Configures the regions where users are allowed to send verification SMS for the project or tenant. This is based on the calling code of the destination phone number. # Configures which regions are enabled for SMS verification code sending.
    &quot;allowByDefault&quot;: { # Defines a policy of allowing every region by default and adding disallowed regions to a disallow list. # A policy of allowing SMS to every region by default and adding disallowed regions to a disallow list.
      &quot;disallowedRegions&quot;: [ # Two letter unicode region codes to disallow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
        &quot;A String&quot;,
      ],
    },
    &quot;allowlistOnly&quot;: { # Defines a policy of only allowing regions by explicitly adding them to an allowlist. # A policy of only allowing regions by explicitly adding them to an allowlist.
      &quot;allowedRegions&quot;: [ # Two letter unicode region codes to allow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
        &quot;A String&quot;,
      ],
    },
  },
  &quot;testPhoneNumbers&quot;: { # A map of pairs that can be used for MFA. The phone number should be in E.164 format (https://www.itu.int/rec/T-REC-E.164/) and a maximum of 10 pairs can be added (error will be thrown once exceeded).
    &quot;a_key&quot;: &quot;A String&quot;,
  },
}

  updateMask: string, If provided, only update fields set in the update mask. Otherwise, all settable fields will be updated. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Tenant contains configuration for the tenant in a multi-tenant project.
  &quot;allowPasswordSignup&quot;: True or False, # Whether to allow email/password user authentication.
  &quot;autodeleteAnonymousUsers&quot;: True or False, # Whether anonymous users will be auto-deleted after a period of 30 days.
  &quot;client&quot;: { # Options related to how clients making requests on behalf of a tenant should be configured. # Options related to how clients making requests on behalf of a project should be configured.
    &quot;permissions&quot;: { # Configuration related to restricting a user&#x27;s ability to affect their account. # Configuration related to restricting a user&#x27;s ability to affect their account.
      &quot;disabledUserDeletion&quot;: True or False, # When true, end users cannot delete their account on the associated project through any of our API methods
      &quot;disabledUserSignup&quot;: True or False, # When true, end users cannot sign up for a new account on the associated project through any of our API methods
    },
  },
  &quot;disableAuth&quot;: True or False, # Whether authentication is disabled for the tenant. If true, the users under the disabled tenant are not allowed to sign-in. Admins of the disabled tenant are not able to manage its users.
  &quot;displayName&quot;: &quot;A String&quot;, # Display name of the tenant.
  &quot;emailPrivacyConfig&quot;: { # Configuration for settings related to email privacy and public visibility. Settings in this config protect against email enumeration, but may make some trade-offs in user-friendliness. # Configuration for settings related to email privacy and public visibility.
    &quot;enableImprovedEmailPrivacy&quot;: True or False, # Migrates the project to a state of improved email privacy. For example certain error codes are more generic to avoid giving away information on whether the account exists. In addition, this disables certain features that as a side-effect allow user enumeration. Enabling this toggle disables the fetchSignInMethodsForEmail functionality and changing the user&#x27;s email to an unverified email. It is recommended to remove dependence on this functionality and enable this toggle to improve user privacy.
  },
  &quot;enableAnonymousUser&quot;: True or False, # Whether to enable anonymous user authentication.
  &quot;enableEmailLinkSignin&quot;: True or False, # Whether to enable email link user authentication.
  &quot;hashConfig&quot;: { # History information of the hash algorithm and key. Different accounts&#x27; passwords may be generated by different version. # Output only. Hash config information of a tenant for display on Pantheon. This can only be displayed on Pantheon to avoid the sensitive information to get accidentally leaked. Only returned in GetTenant response to restrict reading of this information. Requires firebaseauth.configs.getHashConfig permission on the agent project for returning this field.
    &quot;algorithm&quot;: &quot;A String&quot;, # Output only. Different password hash algorithms used in Identity Toolkit.
    &quot;memoryCost&quot;: 42, # Output only. Memory cost for hash calculation. Used by scrypt and other similar password derivation algorithms. See https://tools.ietf.org/html/rfc7914 for explanation of field.
    &quot;rounds&quot;: 42, # Output only. How many rounds for hash calculation. Used by scrypt and other similar password derivation algorithms.
    &quot;saltSeparator&quot;: &quot;A String&quot;, # Output only. Non-printable character to be inserted between the salt and plain text password in base64.
    &quot;signerKey&quot;: &quot;A String&quot;, # Output only. Signer key in base64.
  },
  &quot;inheritance&quot;: { # Settings that the tenants will inherit from project level. # Specify the settings that the tenant could inherit.
    &quot;emailSendingConfig&quot;: True or False, # Whether to allow the tenant to inherit custom domains, email templates, and custom SMTP settings. If true, email sent from tenant will follow the project level email sending configurations. If false (by default), emails will go with the default settings with no customizations.
  },
  &quot;mfaConfig&quot;: { # Options related to MultiFactor Authentication for the project. # The tenant-level configuration of MFA options.
    &quot;enabledProviders&quot;: [ # A list of usable second factors for this project.
      &quot;A String&quot;,
    ],
    &quot;providerConfigs&quot;: [ # A list of usable second factors for this project along with their configurations. This field does not support phone based MFA, for that use the &#x27;enabled_providers&#x27; field.
      { # ProviderConfig describes the supported MFA providers along with their configurations.
        &quot;state&quot;: &quot;A String&quot;, # Describes the state of the MultiFactor Authentication type.
        &quot;totpProviderConfig&quot;: { # TotpMFAProviderConfig represents the TOTP based MFA provider. # TOTP MFA provider config for this project.
          &quot;adjacentIntervals&quot;: 42, # The allowed number of adjacent intervals that will be used for verification to avoid clock skew.
        },
      },
    ],
    &quot;state&quot;: &quot;A String&quot;, # Whether MultiFactor Authentication has been enabled for this project.
  },
  &quot;mobileLinksConfig&quot;: { # Configuration mobile links. # Optional. Deprecated. Never launched. Configuration for settings related to univeral links (iOS) and app links (Android).
    &quot;domain&quot;: &quot;A String&quot;, # Open code in app domain to use for app links and universal links.
  },
  &quot;monitoring&quot;: { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity.
    &quot;requestLogging&quot;: { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging
      &quot;enabled&quot;: True or False, # Whether logging is enabled for this project or not.
    },
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of a tenant. For example: &quot;projects/{project-id}/tenants/{tenant-id}&quot;
  &quot;passwordPolicyConfig&quot;: { # The configuration for the password policy on the project. # The tenant-level password policy config
    &quot;forceUpgradeOnSignin&quot;: True or False, # Users must have a password compliant with the password policy to sign-in.
    &quot;lastUpdateTime&quot;: &quot;A String&quot;, # Output only. The last time the password policy on the project was updated.
    &quot;passwordPolicyEnforcementState&quot;: &quot;A String&quot;, # Which enforcement mode to use for the password policy.
    &quot;passwordPolicyVersions&quot;: [ # Must be of length 1. Contains the strength attributes for the password policy.
      { # The strength attributes for the password policy on the project.
        &quot;customStrengthOptions&quot;: { # Custom strength options to enforce on user passwords. # The custom strength options enforced by the password policy.
          &quot;containsLowercaseCharacter&quot;: True or False, # The password must contain a lower case character.
          &quot;containsNonAlphanumericCharacter&quot;: True or False, # The password must contain a non alpha numeric character.
          &quot;containsNumericCharacter&quot;: True or False, # The password must contain a number.
          &quot;containsUppercaseCharacter&quot;: True or False, # The password must contain an upper case character.
          &quot;maxPasswordLength&quot;: 42, # Maximum password length. No default max length
          &quot;minPasswordLength&quot;: 42, # Minimum password length. Range from 6 to 30
        },
        &quot;schemaVersion&quot;: 42, # Output only. schema version number for the password policy
      },
    ],
  },
  &quot;recaptchaConfig&quot;: { # The reCAPTCHA Enterprise integration config. # The tenant-level reCAPTCHA config.
    &quot;emailPasswordEnforcementState&quot;: &quot;A String&quot;, # The reCAPTCHA config for email/password provider, containing the enforcement status. The email/password provider contains all email related user flows protected by reCAPTCHA.
    &quot;managedRules&quot;: [ # The managed rules for authentication action based on reCAPTCHA scores. The rules are shared across providers for a given tenant project.
      { # The config for a reCAPTCHA managed rule. Models a single interval [start_score, end_score]. The start_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.
        &quot;action&quot;: &quot;A String&quot;, # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].
        &quot;endScore&quot;: 3.14, # The end score (inclusive) of the score range for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the riskiest request (likely a bot), whereas 1.0 indicates the safest request (likely a human). See https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment.
      },
    ],
    &quot;phoneEnforcementState&quot;: &quot;A String&quot;, # The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all SMS related user flows protected by reCAPTCHA.
    &quot;recaptchaKeys&quot;: [ # The reCAPTCHA keys.
      { # The reCAPTCHA key config. reCAPTCHA Enterprise offers different keys for different client platforms.
        &quot;key&quot;: &quot;A String&quot;, # The reCAPTCHA Enterprise key resource name, e.g. &quot;projects/{project}/keys/{key}&quot;
        &quot;type&quot;: &quot;A String&quot;, # The client&#x27;s platform type.
      },
    ],
    &quot;tollFraudManagedRules&quot;: [ # The managed rules for the authentication action based on reCAPTCHA toll fraud risk scores. Toll fraud managed rules will only take effect when the phone_enforcement_state is AUDIT or ENFORCE and use_sms_toll_fraud_protection is true.
      { # The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The end_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.
        &quot;action&quot;: &quot;A String&quot;, # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].
        &quot;startScore&quot;: 3.14, # The start score (inclusive) for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms.
      },
    ],
    &quot;useAccountDefender&quot;: True or False, # Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`.
    &quot;useSmsBotScore&quot;: True or False, # Whether to use the rCE bot score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
    &quot;useSmsTollFraudProtection&quot;: True or False, # Whether to use the rCE sms toll fraud protection risk score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
  },
  &quot;smsRegionConfig&quot;: { # Configures the regions where users are allowed to send verification SMS for the project or tenant. This is based on the calling code of the destination phone number. # Configures which regions are enabled for SMS verification code sending.
    &quot;allowByDefault&quot;: { # Defines a policy of allowing every region by default and adding disallowed regions to a disallow list. # A policy of allowing SMS to every region by default and adding disallowed regions to a disallow list.
      &quot;disallowedRegions&quot;: [ # Two letter unicode region codes to disallow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
        &quot;A String&quot;,
      ],
    },
    &quot;allowlistOnly&quot;: { # Defines a policy of only allowing regions by explicitly adding them to an allowlist. # A policy of only allowing regions by explicitly adding them to an allowlist.
      &quot;allowedRegions&quot;: [ # Two letter unicode region codes to allow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
        &quot;A String&quot;,
      ],
    },
  },
  &quot;testPhoneNumbers&quot;: { # A map of pairs that can be used for MFA. The phone number should be in E.164 format (https://www.itu.int/rec/T-REC-E.164/) and a maximum of 10 pairs can be added (error will be thrown once exceeded).
    &quot;a_key&quot;: &quot;A String&quot;,
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
  <pre>Sets the access control policy for a resource. If the policy exists, it is replaced. Caller must have the right Google IAM permission on the resource.

Args:
  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for `SetIamPolicy` method.
  &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
    &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
        &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
          { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
            &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
              &quot;A String&quot;,
            ],
            &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
          },
        ],
        &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
      },
    ],
    &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
      { # Associates `members`, or principals, with a `role`.
        &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
          &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
          &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
          &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
          &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
        },
        &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
          &quot;A String&quot;,
        ],
        &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
      },
    ],
    &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
    &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
  },
  &quot;updateMask&quot;: &quot;A String&quot;, # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: &quot;bindings, etag&quot;`
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
  &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
      &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
        { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
          &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
            &quot;A String&quot;,
          ],
          &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
        },
      ],
      &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
    },
  ],
  &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
    { # Associates `members`, or principals, with a `role`.
      &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
        &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
        &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
        &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
        &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
      },
      &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
        &quot;A String&quot;,
      ],
      &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
    },
  ],
  &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
  &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>

<div class="method">
    <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
  <pre>Returns the caller&#x27;s permissions on a resource. An error is returned if the resource does not exist. A caller is not required to have Google IAM permission to make this request.

Args:
  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for `TestIamPermissions` method.
  &quot;permissions&quot;: [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
    &quot;A String&quot;,
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for `TestIamPermissions` method.
  &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
    &quot;A String&quot;,
  ],
}</pre>
</div>

</body></html>