Skip to content

Commit 8a8bc2a

Browse files
feat(identitytoolkit): update the api
#### identitytoolkit:v2 The following keys were added: - schemas.GoogleCloudIdentitytoolkitAdminV2MultiFactorAuthConfig.properties.providerConfigs (Total Keys: 2) - schemas.GoogleCloudIdentitytoolkitAdminV2ProviderConfig (Total Keys: 4) - schemas.GoogleCloudIdentitytoolkitAdminV2TotpMfaProviderConfig (Total Keys: 4) - schemas.GoogleCloudIdentitytoolkitV2FinalizeMfaEnrollmentRequest.properties.totpVerificationInfo.$ref (Total Keys: 1) - schemas.GoogleCloudIdentitytoolkitV2FinalizeMfaEnrollmentResponse.properties.totpAuthInfo.$ref (Total Keys: 1) - schemas.GoogleCloudIdentitytoolkitV2FinalizeMfaSignInRequest.properties.mfaEnrollmentId.type (Total Keys: 1) - schemas.GoogleCloudIdentitytoolkitV2FinalizeMfaSignInRequest.properties.totpVerificationInfo.$ref (Total Keys: 1) - schemas.GoogleCloudIdentitytoolkitV2FinalizeMfaTotpEnrollmentRequestInfo (Total Keys: 4) - schemas.GoogleCloudIdentitytoolkitV2FinalizeMfaTotpEnrollmentResponseInfo (Total Keys: 2) - schemas.GoogleCloudIdentitytoolkitV2MfaTotpSignInRequestInfo (Total Keys: 3) - schemas.GoogleCloudIdentitytoolkitV2StartMfaEnrollmentRequest.properties.totpEnrollmentInfo.$ref (Total Keys: 1) - schemas.GoogleCloudIdentitytoolkitV2StartMfaEnrollmentResponse.properties.totpSessionInfo.$ref (Total Keys: 1) - schemas.GoogleCloudIdentitytoolkitV2StartMfaTotpEnrollmentRequestInfo (Total Keys: 2) - schemas.GoogleCloudIdentitytoolkitV2StartMfaTotpEnrollmentResponseInfo (Total Keys: 11)
1 parent 36b6d60 commit 8a8bc2a

7 files changed

+238
-4
lines changed

docs/dyn/identitytoolkit_v1.accounts.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -597,7 +597,7 @@ <h3>Method Details</h3>
597597
&quot;delegatedProjectNumber&quot;: &quot;A String&quot;,
598598
&quot;idToken&quot;: &quot;A String&quot;, # A valid Identity Platform ID token. If passed, the user&#x27;s account at the IdP will be linked to the account represented by this ID token.
599599
&quot;pendingIdToken&quot;: &quot;A String&quot;,
600-
&quot;pendingToken&quot;: &quot;A String&quot;, # An opaque string from a previous SignInWithIdp response. If set, it can be used to repeat the sign-in operation from the previous SignInWithIdp operation.
600+
&quot;pendingToken&quot;: &quot;A String&quot;, # An opaque string from a previous SignInWithIdp response. If set, it can be used to repeat the sign-in operation from the previous SignInWithIdp operation. This may be present if the user needs to confirm their account information as part of a previous federated login attempt, or perform account linking.
601601
&quot;postBody&quot;: &quot;A String&quot;, # If the user is signing in with an authorization response obtained via a previous CreateAuthUri authorization request, this is the body of the HTTP POST callback from the IdP, if present. Otherwise, if the user is signing in with a manually provided IdP credential, this should be a URL-encoded form that contains the credential (e.g. an ID token or access token for OAuth 2.0 IdPs) and the provider ID of the IdP that issued the credential. For example, if the user is signing in to the Google provider using a Google ID token, this should be set to `id_token=[GOOGLE_ID_TOKEN]&amp;providerId=google.com`, where `[GOOGLE_ID_TOKEN]` should be replaced with the Google ID token. If the user is signing in to the Facebook provider using a Facebook authentication token, this should be set to `id_token=[FACEBOOK_AUTHENTICATION_TOKEN]&amp;providerId=facebook.com&amp;nonce= [NONCE]`, where `[FACEBOOK_AUTHENTICATION_TOKEN]` should be replaced with the Facebook authentication token. Nonce is required for validating the token. The request will fail if no nonce is provided. If the user is signing in to the Facebook provider using a Facebook access token, this should be set to `access_token=[FACEBOOK_ACCESS_TOKEN]&amp;providerId=facebook.com`, where `[FACEBOOK_ACCESS_TOKEN]` should be replaced with the Facebook access token. If the user is signing in to the Twitter provider using a Twitter OAuth 1.0 credential, this should be set to `access_token=[TWITTER_ACCESS_TOKEN]&amp;oauth_token_secret=[TWITTER_TOKEN_SECRET]&amp;providerId=twitter.com`, where `[TWITTER_ACCESS_TOKEN]` and `[TWITTER_TOKEN_SECRET]` should be replaced with the Twitter OAuth access token and Twitter OAuth token secret respectively.
602602
&quot;requestUri&quot;: &quot;A String&quot;, # Required. The URL to which the IdP redirects the user back. This can be set to `http://localhost` if the user is signing in with a manually provided IdP credential.
603603
&quot;returnIdpCredential&quot;: True or False, # Whether or not to return OAuth credentials from the IdP on the following errors: `FEDERATED_USER_ID_ALREADY_LINKED` and `EMAIL_EXISTS`.

docs/dyn/identitytoolkit_v2.accounts.mfaEnrollment.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,10 @@ <h3>Method Details</h3>
110110
&quot;sessionInfo&quot;: &quot;A String&quot;, # An opaque string that represents the enrollment session.
111111
},
112112
&quot;tenantId&quot;: &quot;A String&quot;, # The ID of the Identity Platform tenant that the user enrolling MFA belongs to. If not set, the user belongs to the default Identity Platform project.
113+
&quot;totpVerificationInfo&quot;: { # Mfa request info specific to TOTP auth for FinalizeMfa. # Verification information for TOTP.
114+
&quot;sessionInfo&quot;: &quot;A String&quot;, # An opaque string that represents the enrollment session.
115+
&quot;verificationCode&quot;: &quot;A String&quot;, # User-entered verification code.
116+
},
113117
}
114118

115119
x__xgafv: string, V1 error format.
@@ -128,6 +132,8 @@ <h3>Method Details</h3>
128132
&quot;phoneNumber&quot;: &quot;A String&quot;, # For Android verification proof.
129133
},
130134
&quot;refreshToken&quot;: &quot;A String&quot;, # Refresh token updated to reflect MFA enrollment.
135+
&quot;totpAuthInfo&quot;: { # Mfa response info specific to TOTP auth for FinalizeMfa. # Auxiliary auth info specific to TOTP auth.
136+
},
131137
}</pre>
132138
</div>
133139

@@ -153,6 +159,8 @@ <h3>Method Details</h3>
153159
&quot;safetyNetToken&quot;: &quot;A String&quot;, # Android only. Used to assert application identity in place of a recaptcha token. A SafetyNet Token can be generated via the [SafetyNet Android Attestation API](https://developer.android.com/training/safetynet/attestation.html), with the Base64 encoding of the `phone_number` field as the nonce.
154160
},
155161
&quot;tenantId&quot;: &quot;A String&quot;, # The ID of the Identity Platform tenant that the user enrolling MFA belongs to. If not set, the user belongs to the default Identity Platform project.
162+
&quot;totpEnrollmentInfo&quot;: { # Mfa request info specific to TOTP auth for StartMfa. # Sign-in info specific to TOTP auth.
163+
},
156164
}
157165

158166
x__xgafv: string, V1 error format.
@@ -167,6 +175,14 @@ <h3>Method Details</h3>
167175
&quot;phoneSessionInfo&quot;: { # Phone Verification info for a StartMfa response. # Verification info to authorize sending an SMS for phone verification.
168176
&quot;sessionInfo&quot;: &quot;A String&quot;, # An opaque string that represents the enrollment session.
169177
},
178+
&quot;totpSessionInfo&quot;: { # Mfa response info specific to TOTP auth for StartMfa. # Enrollment response info specific to TOTP auth.
179+
&quot;finalizeEnrollmentTime&quot;: &quot;A String&quot;, # The time by which the enrollment must finish.
180+
&quot;hashingAlgorithm&quot;: &quot;A String&quot;, # The hashing algorithm used to generate the verification code.
181+
&quot;periodSec&quot;: 42, # Duration in seconds at which the verification code will change.
182+
&quot;sessionInfo&quot;: &quot;A String&quot;, # An encoded string that represents the enrollment session.
183+
&quot;sharedSecretKey&quot;: &quot;A String&quot;, # A base 32 encoded string that represents the shared TOTP secret. The base 32 encoding is the one specified by [RFC4648#section-6](https://datatracker.ietf.org/doc/html/rfc4648#section-6). (This is the same as the base 32 encoding from [RFC3548#section-5](https://datatracker.ietf.org/doc/html/rfc3548#section-5).)
184+
&quot;verificationCodeLength&quot;: 42, # The length of the verification code that needs to be generated.
185+
},
170186
}</pre>
171187
</div>
172188

docs/dyn/identitytoolkit_v2.accounts.mfaSignIn.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ <h3>Method Details</h3>
9898
The object takes the form of:
9999

100100
{ # Finalizes sign-in by verifying MFA challenge.
101+
&quot;mfaEnrollmentId&quot;: &quot;A String&quot;, # The MFA enrollment ID from the user&#x27;s list of current MFA enrollments.
101102
&quot;mfaPendingCredential&quot;: &quot;A String&quot;, # Required. Pending credential from first factor sign-in.
102103
&quot;phoneVerificationInfo&quot;: { # Phone Verification info for a FinalizeMfa request. # Proof of completion of the SMS based MFA challenge.
103104
&quot;androidVerificationProof&quot;: &quot;A String&quot;, # Android only. Uses for &quot;instant&quot; phone number verification though GmsCore.
@@ -106,6 +107,9 @@ <h3>Method Details</h3>
106107
&quot;sessionInfo&quot;: &quot;A String&quot;, # An opaque string that represents the enrollment session.
107108
},
108109
&quot;tenantId&quot;: &quot;A String&quot;, # The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform project.
110+
&quot;totpVerificationInfo&quot;: { # TOTP verification info for FinalizeMfaSignInRequest. # Proof of completion of the TOTP based MFA challenge.
111+
&quot;verificationCode&quot;: &quot;A String&quot;, # User-entered verification code.
112+
},
109113
}
110114

111115
x__xgafv: string, V1 error format.

docs/dyn/identitytoolkit_v2.projects.html

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,14 @@ <h3>Method Details</h3>
161161
&quot;enabledProviders&quot;: [ # A list of usable second factors for this project.
162162
&quot;A String&quot;,
163163
],
164+
&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.
165+
{ # ProviderConfig describes the supported MFA providers along with their configurations.
166+
&quot;state&quot;: &quot;A String&quot;, # Describes the state of the MultiFactor Authentication type.
167+
&quot;totpProviderConfig&quot;: { # TotpMFAProviderConfig represents the TOTP based MFA provider. # TOTP MFA provider config for this project.
168+
&quot;adjacentIntervals&quot;: 42, # The allowed number of adjacent intervals that will be used for verification to avoid clock skew.
169+
},
170+
},
171+
],
164172
&quot;state&quot;: &quot;A String&quot;, # Whether MultiFactor Authentication has been enabled for this project.
165173
},
166174
&quot;monitoring&quot;: { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity.
@@ -334,6 +342,14 @@ <h3>Method Details</h3>
334342
&quot;enabledProviders&quot;: [ # A list of usable second factors for this project.
335343
&quot;A String&quot;,
336344
],
345+
&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.
346+
{ # ProviderConfig describes the supported MFA providers along with their configurations.
347+
&quot;state&quot;: &quot;A String&quot;, # Describes the state of the MultiFactor Authentication type.
348+
&quot;totpProviderConfig&quot;: { # TotpMFAProviderConfig represents the TOTP based MFA provider. # TOTP MFA provider config for this project.
349+
&quot;adjacentIntervals&quot;: 42, # The allowed number of adjacent intervals that will be used for verification to avoid clock skew.
350+
},
351+
},
352+
],
337353
&quot;state&quot;: &quot;A String&quot;, # Whether MultiFactor Authentication has been enabled for this project.
338354
},
339355
&quot;monitoring&quot;: { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity.
@@ -506,6 +522,14 @@ <h3>Method Details</h3>
506522
&quot;enabledProviders&quot;: [ # A list of usable second factors for this project.
507523
&quot;A String&quot;,
508524
],
525+
&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.
526+
{ # ProviderConfig describes the supported MFA providers along with their configurations.
527+
&quot;state&quot;: &quot;A String&quot;, # Describes the state of the MultiFactor Authentication type.
528+
&quot;totpProviderConfig&quot;: { # TotpMFAProviderConfig represents the TOTP based MFA provider. # TOTP MFA provider config for this project.
529+
&quot;adjacentIntervals&quot;: 42, # The allowed number of adjacent intervals that will be used for verification to avoid clock skew.
530+
},
531+
},
532+
],
509533
&quot;state&quot;: &quot;A String&quot;, # Whether MultiFactor Authentication has been enabled for this project.
510534
},
511535
&quot;monitoring&quot;: { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity.

docs/dyn/identitytoolkit_v2.projects.tenants.html

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,14 @@ <h3>Method Details</h3>
164164
&quot;enabledProviders&quot;: [ # A list of usable second factors for this project.
165165
&quot;A String&quot;,
166166
],
167+
&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.
168+
{ # ProviderConfig describes the supported MFA providers along with their configurations.
169+
&quot;state&quot;: &quot;A String&quot;, # Describes the state of the MultiFactor Authentication type.
170+
&quot;totpProviderConfig&quot;: { # TotpMFAProviderConfig represents the TOTP based MFA provider. # TOTP MFA provider config for this project.
171+
&quot;adjacentIntervals&quot;: 42, # The allowed number of adjacent intervals that will be used for verification to avoid clock skew.
172+
},
173+
},
174+
],
167175
&quot;state&quot;: &quot;A String&quot;, # Whether MultiFactor Authentication has been enabled for this project.
168176
},
169177
&quot;monitoring&quot;: { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity.
@@ -227,6 +235,14 @@ <h3>Method Details</h3>
227235
&quot;enabledProviders&quot;: [ # A list of usable second factors for this project.
228236
&quot;A String&quot;,
229237
],
238+
&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.
239+
{ # ProviderConfig describes the supported MFA providers along with their configurations.
240+
&quot;state&quot;: &quot;A String&quot;, # Describes the state of the MultiFactor Authentication type.
241+
&quot;totpProviderConfig&quot;: { # TotpMFAProviderConfig represents the TOTP based MFA provider. # TOTP MFA provider config for this project.
242+
&quot;adjacentIntervals&quot;: 42, # The allowed number of adjacent intervals that will be used for verification to avoid clock skew.
243+
},
244+
},
245+
],
230246
&quot;state&quot;: &quot;A String&quot;, # Whether MultiFactor Authentication has been enabled for this project.
231247
},
232248
&quot;monitoring&quot;: { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity.
@@ -315,6 +331,14 @@ <h3>Method Details</h3>
315331
&quot;enabledProviders&quot;: [ # A list of usable second factors for this project.
316332
&quot;A String&quot;,
317333
],
334+
&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.
335+
{ # ProviderConfig describes the supported MFA providers along with their configurations.
336+
&quot;state&quot;: &quot;A String&quot;, # Describes the state of the MultiFactor Authentication type.
337+
&quot;totpProviderConfig&quot;: { # TotpMFAProviderConfig represents the TOTP based MFA provider. # TOTP MFA provider config for this project.
338+
&quot;adjacentIntervals&quot;: 42, # The allowed number of adjacent intervals that will be used for verification to avoid clock skew.
339+
},
340+
},
341+
],
318342
&quot;state&quot;: &quot;A String&quot;, # Whether MultiFactor Authentication has been enabled for this project.
319343
},
320344
&quot;monitoring&quot;: { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity.
@@ -446,6 +470,14 @@ <h3>Method Details</h3>
446470
&quot;enabledProviders&quot;: [ # A list of usable second factors for this project.
447471
&quot;A String&quot;,
448472
],
473+
&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.
474+
{ # ProviderConfig describes the supported MFA providers along with their configurations.
475+
&quot;state&quot;: &quot;A String&quot;, # Describes the state of the MultiFactor Authentication type.
476+
&quot;totpProviderConfig&quot;: { # TotpMFAProviderConfig represents the TOTP based MFA provider. # TOTP MFA provider config for this project.
477+
&quot;adjacentIntervals&quot;: 42, # The allowed number of adjacent intervals that will be used for verification to avoid clock skew.
478+
},
479+
},
480+
],
449481
&quot;state&quot;: &quot;A String&quot;, # Whether MultiFactor Authentication has been enabled for this project.
450482
},
451483
&quot;monitoring&quot;: { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity.
@@ -527,6 +559,14 @@ <h3>Method Details</h3>
527559
&quot;enabledProviders&quot;: [ # A list of usable second factors for this project.
528560
&quot;A String&quot;,
529561
],
562+
&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.
563+
{ # ProviderConfig describes the supported MFA providers along with their configurations.
564+
&quot;state&quot;: &quot;A String&quot;, # Describes the state of the MultiFactor Authentication type.
565+
&quot;totpProviderConfig&quot;: { # TotpMFAProviderConfig represents the TOTP based MFA provider. # TOTP MFA provider config for this project.
566+
&quot;adjacentIntervals&quot;: 42, # The allowed number of adjacent intervals that will be used for verification to avoid clock skew.
567+
},
568+
},
569+
],
530570
&quot;state&quot;: &quot;A String&quot;, # Whether MultiFactor Authentication has been enabled for this project.
531571
},
532572
&quot;monitoring&quot;: { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity.
@@ -591,6 +631,14 @@ <h3>Method Details</h3>
591631
&quot;enabledProviders&quot;: [ # A list of usable second factors for this project.
592632
&quot;A String&quot;,
593633
],
634+
&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.
635+
{ # ProviderConfig describes the supported MFA providers along with their configurations.
636+
&quot;state&quot;: &quot;A String&quot;, # Describes the state of the MultiFactor Authentication type.
637+
&quot;totpProviderConfig&quot;: { # TotpMFAProviderConfig represents the TOTP based MFA provider. # TOTP MFA provider config for this project.
638+
&quot;adjacentIntervals&quot;: 42, # The allowed number of adjacent intervals that will be used for verification to avoid clock skew.
639+
},
640+
},
641+
],
594642
&quot;state&quot;: &quot;A String&quot;, # Whether MultiFactor Authentication has been enabled for this project.
595643
},
596644
&quot;monitoring&quot;: { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity.

googleapiclient/discovery_cache/documents/identitytoolkit.v1.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1237,7 +1237,7 @@
12371237
}
12381238
}
12391239
},
1240-
"revision": "20230318",
1240+
"revision": "20230327",
12411241
"rootUrl": "https://identitytoolkit.googleapis.com/",
12421242
"schemas": {
12431243
"GoogleCloudIdentitytoolkitV1Argon2Parameters": {
@@ -2841,7 +2841,7 @@
28412841
"type": "string"
28422842
},
28432843
"pendingToken": {
2844-
"description": "An opaque string from a previous SignInWithIdp response. If set, it can be used to repeat the sign-in operation from the previous SignInWithIdp operation.",
2844+
"description": "An opaque string from a previous SignInWithIdp response. If set, it can be used to repeat the sign-in operation from the previous SignInWithIdp operation. This may be present if the user needs to confirm their account information as part of a previous federated login attempt, or perform account linking.",
28452845
"type": "string"
28462846
},
28472847
"postBody": {

0 commit comments

Comments
 (0)