Skip to content

Commit

Permalink
feat(identitytoolkit): update the api
Browse files Browse the repository at this point in the history
#### identitytoolkit:v2

The following keys were added:
- schemas.GoogleCloudIdentitytoolkitAdminV2Config.properties.emailPrivacyConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudIdentitytoolkitAdminV2EmailPrivacyConfig (Total Keys: 3)
- schemas.GoogleCloudIdentitytoolkitAdminV2Tenant.properties.emailPrivacyConfig.$ref (Total Keys: 1)
  • Loading branch information
yoshi-automation committed Nov 15, 2022
1 parent 9e5ca02 commit 57db5e8
Show file tree
Hide file tree
Showing 7 changed files with 85 additions and 39 deletions.
16 changes: 8 additions & 8 deletions docs/dyn/identitytoolkit_v1.accounts.html
Expand Up @@ -124,7 +124,7 @@ <h2>Instance Methods</h2>
<p class="firstline">Updates account-related information for the specified user by setting specific fields or applying action codes. Requests from administrators and end users are supported.</p>
<p class="toc_element">
<code><a href="#verifyIosClient">verifyIosClient(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Verifies an iOS client is a real iOS device. If the request is valid, a reciept will be sent in the response and a secret will be sent via Apple Push Notification Service. The client should send both of them back to certain Identity Platform APIs in a later call (for example, /accounts:sendVerificationCode), in order to verify the client. The bundle ID is required in the request header as `x-ios-bundle-identifier`. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.</p>
<p class="firstline">Verifies an iOS client is a real iOS device. If the request is valid, a receipt will be sent in the response and a secret will be sent via Apple Push Notification Service. The client should send both of them back to certain Identity Platform APIs in a later call (for example, /accounts:sendVerificationCode), in order to verify the client. The bundle ID is required in the request header as `x-ios-bundle-identifier`. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
Expand Down Expand Up @@ -815,7 +815,7 @@ <h3>Method Details</h3>
&quot;captchaChallenge&quot;: &quot;A String&quot;,
&quot;captchaResponse&quot;: &quot;A String&quot;, # The response from reCaptcha challenge. This is required when the system detects possible abuse activities.
&quot;createdAt&quot;: &quot;A String&quot;, # The timestamp in milliseconds when the account was created.
&quot;customAttributes&quot;: &quot;A String&quot;, # JSON formatted custom attributes to be stored in the Identity Platform ID token. Specifying this field requires a Google OAuth 2.0 credential with proper permissions (https://cloud.google.com/identity-platform/docs/access-control).
&quot;customAttributes&quot;: &quot;A String&quot;, # JSON formatted custom attributes to be stored in the Identity Platform ID token. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control).
&quot;delegatedProjectNumber&quot;: &quot;A String&quot;,
&quot;deleteAttribute&quot;: [ # The account&#x27;s attributes to be deleted.
&quot;A String&quot;,
Expand All @@ -826,11 +826,11 @@ <h3>Method Details</h3>
&quot;disableUser&quot;: True or False, # If true, marks the account as disabled, meaning the user will no longer be able to sign-in.
&quot;displayName&quot;: &quot;A String&quot;, # The user&#x27;s new display name to be updated in the account&#x27;s attributes. The length of the display name must be less than or equal to 256 characters.
&quot;email&quot;: &quot;A String&quot;, # The user&#x27;s new email to be updated in the account&#x27;s attributes. The length of email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production.
&quot;emailVerified&quot;: True or False, # Whether the user&#x27;s email has been verified. Specifying this field requires a Google OAuth 2.0 credential with proper permissions (https://cloud.google.com/identity-platform/docs/access-control).
&quot;emailVerified&quot;: True or False, # Whether the user&#x27;s email has been verified. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control).
&quot;idToken&quot;: &quot;A String&quot;, # A valid Identity Platform ID token. Required when attempting to change user-related information.
&quot;instanceId&quot;: &quot;A String&quot;,
&quot;lastLoginAt&quot;: &quot;A String&quot;, # The timestamp in milliseconds when the account last logged in.
&quot;linkProviderUserInfo&quot;: { # Information about the user as provided by various Identity Providers. # The provider to be linked to the user&#x27;s account. Specifying this field requires a Google OAuth 2.0 credential with proper permissions (https://cloud.google.com/identity-platform/docs/access-control).
&quot;linkProviderUserInfo&quot;: { # Information about the user as provided by various Identity Providers. # The provider to be linked to the user&#x27;s account. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control).
&quot;displayName&quot;: &quot;A String&quot;, # The user&#x27;s display name at the Identity Provider.
&quot;email&quot;: &quot;A String&quot;, # The user&#x27;s email address at the Identity Provider.
&quot;federatedId&quot;: &quot;A String&quot;, # The user&#x27;s identifier at the Identity Provider.
Expand All @@ -840,8 +840,8 @@ <h3>Method Details</h3>
&quot;rawId&quot;: &quot;A String&quot;, # The user&#x27;s raw identifier directly returned from Identity Provider.
&quot;screenName&quot;: &quot;A String&quot;, # The user&#x27;s screen_name at Twitter or login name at GitHub.
},
&quot;localId&quot;: &quot;A String&quot;, # The ID of the user. Specifying this field requires a Google OAuth 2.0 credential with proper permissions (https://cloud.google.com/identity-platform/docs/access-control). For requests from end-users, an ID token should be passed instead.
&quot;mfa&quot;: { # Multi-factor authentication related information. # The multi-factor authentication related information to be set on the user&#x27;s account. This will overwrite any previous multi-factor related information on the account. Specifying this field requires a Google OAuth 2.0 credential with proper permissions (https://cloud.google.com/identity-platform/docs/access-control).
&quot;localId&quot;: &quot;A String&quot;, # The ID of the user. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control). For requests from end-users, an ID token should be passed instead.
&quot;mfa&quot;: { # Multi-factor authentication related information. # The multi-factor authentication related information to be set on the user&#x27;s account. This will overwrite any previous multi-factor related information on the account. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control).
&quot;enrollments&quot;: [ # The second factors the user has enrolled.
{ # Information on which multi-factor authentication (MFA) providers are enabled for an account.
&quot;displayName&quot;: &quot;A String&quot;, # Display name for this mfa option e.g. &quot;corp cell phone&quot;.
Expand All @@ -860,7 +860,7 @@ <h3>Method Details</h3>
&quot;A String&quot;,
],
&quot;returnSecureToken&quot;: True or False, # Whether or not to return an ID and refresh token. Should always be true.
&quot;targetProjectId&quot;: &quot;A String&quot;, # The project ID for the project that the account belongs to. Specifying this field requires Google OAuth 2.0 credential with proper permissions (https://cloud.google.com/identity-platform/docs/access-control). Requests from end users should pass an Identity Platform ID token instead.
&quot;targetProjectId&quot;: &quot;A String&quot;, # The project ID for the project that the account belongs to. Specifying this field requires Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control). Requests from end users should pass an Identity Platform ID token instead.
&quot;tenantId&quot;: &quot;A String&quot;, # The tenant ID of the Identity Platform tenant that the account belongs to. Requests from end users should pass an Identity Platform ID token rather than setting this field.
&quot;upgradeToFederatedLogin&quot;: True or False, # Whether the account should be restricted to only using federated login.
&quot;validSince&quot;: &quot;A String&quot;, # Specifies the minimum timestamp in seconds for an Identity Platform ID token to be considered valid.
Expand Down Expand Up @@ -903,7 +903,7 @@ <h3>Method Details</h3>

<div class="method">
<code class="details" id="verifyIosClient">verifyIosClient(body=None, x__xgafv=None)</code>
<pre>Verifies an iOS client is a real iOS device. If the request is valid, a reciept will be sent in the response and a secret will be sent via Apple Push Notification Service. The client should send both of them back to certain Identity Platform APIs in a later call (for example, /accounts:sendVerificationCode), in order to verify the client. The bundle ID is required in the request header as `x-ios-bundle-identifier`. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.
<pre>Verifies an iOS client is a real iOS device. If the request is valid, a receipt will be sent in the response and a secret will be sent via Apple Push Notification Service. The client should send both of them back to certain Identity Platform APIs in a later call (for example, /accounts:sendVerificationCode), in order to verify the client. The bundle ID is required in the request header as `x-ios-bundle-identifier`. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.

Args:
body: object, The request body.
Expand Down

0 comments on commit 57db5e8

Please sign in to comment.