Update docs
diff --git a/docs/dyn/identitytoolkit_v3.relyingparty.html b/docs/dyn/identitytoolkit_v3.relyingparty.html
index eb3f861..9dfe651 100644
--- a/docs/dyn/identitytoolkit_v3.relyingparty.html
+++ b/docs/dyn/identitytoolkit_v3.relyingparty.html
@@ -90,7 +90,7 @@
<code><a href="#getOobConfirmationCode">getOobConfirmationCode(body)</a></code></p>
<p class="firstline">Get a code for user action confirmation.</p>
<p class="toc_element">
- <code><a href="#getProjectConfig">getProjectConfig()</a></code></p>
+ <code><a href="#getProjectConfig">getProjectConfig(delegatedProjectNumber=None, projectNumber=None)</a></code></p>
<p class="firstline">Get project configuration.</p>
<p class="toc_element">
<code><a href="#getPublicKeys">getPublicKeys()</a></code></p>
@@ -105,6 +105,9 @@
<code><a href="#setAccountInfo">setAccountInfo(body)</a></code></p>
<p class="firstline">Set account info for a user.</p>
<p class="toc_element">
+ <code><a href="#setProjectConfig">setProjectConfig(body)</a></code></p>
+<p class="firstline">Set project configuration.</p>
+<p class="toc_element">
<code><a href="#signOutUser">signOutUser(body)</a></code></p>
<p class="firstline">Sign out user.</p>
<p class="toc_element">
@@ -171,6 +174,7 @@
The object takes the form of:
{ # Request to delete account.
+ "idToken": "A String", # The GITKit token or STS id token of the authenticated user.
"delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
"localId": "A String", # The local ID of the user.
}
@@ -218,10 +222,11 @@
"providerUserInfo": [ # The IDP of the user.
{
"federatedId": "A String", # User's identifier at IDP.
- "providerId": "A String", # The IdP ID. For white listed IdPs it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
"displayName": "A String", # The user's display name at the IDP.
- "email": "A String", # User's email at IDP.
"photoUrl": "A String", # The user's photo url at the IDP.
+ "providerId": "A String", # The IdP ID. For white listed IdPs it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
+ "rawId": "A String", # User's raw identifier directly returned from IDP.
+ "email": "A String", # User's email at IDP.
},
],
"passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.
@@ -242,6 +247,7 @@
{ # Request to get the account information.
"idToken": "A String", # The GITKit token of the authenticated user.
+ "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
"email": [ # The list of emails of the users to inquiry.
"A String",
],
@@ -269,10 +275,11 @@
"providerUserInfo": [ # The IDP of the user.
{
"federatedId": "A String", # User's identifier at IDP.
- "providerId": "A String", # The IdP ID. For white listed IdPs it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
"displayName": "A String", # The user's display name at the IDP.
- "email": "A String", # User's email at IDP.
"photoUrl": "A String", # The user's photo url at the IDP.
+ "providerId": "A String", # The IdP ID. For white listed IdPs it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
+ "rawId": "A String", # User's raw identifier directly returned from IDP.
+ "email": "A String", # User's email at IDP.
},
],
"passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.
@@ -314,21 +321,61 @@
</div>
<div class="method">
- <code class="details" id="getProjectConfig">getProjectConfig()</code>
+ <code class="details" id="getProjectConfig">getProjectConfig(delegatedProjectNumber=None, projectNumber=None)</code>
<pre>Get project configuration.
Args:
+ delegatedProjectNumber: string, Delegated GCP project number of the request.
+ projectNumber: string, GCP project number of the request.
Returns:
An object of the form:
{ # Response of getting the project configuration.
- "projectId": "A String", # Project ID of the relying party.
"apiKey": "A String", # Browser API key, needed when making http request to Apiary.
+ "useEmailSending": True or False, # Whether to use email sending provided by Firebear.
+ "projectId": "A String", # Project ID of the relying party.
+ "enableAnonymousUser": True or False, # Whether anonymous user is enabled.
+ "authorizedDomains": [ # Authorized domains.
+ "A String",
+ ],
+ "resetPasswordTemplate": { # Template for an email template. # Reset password email template.
+ "body": "A String", # Email body.
+ "fromDisplayName": "A String", # From display name.
+ "from": "A String", # From address of the email.
+ "format": "A String", # Email body format.
+ "replyTo": "A String", # Reply-to address.
+ "subject": "A String", # Subject of the email.
+ },
+ "legacyResetPasswordTemplate": { # Template for an email template. # Legacy reset password email template.
+ "body": "A String", # Email body.
+ "fromDisplayName": "A String", # From display name.
+ "from": "A String", # From address of the email.
+ "format": "A String", # Email body format.
+ "replyTo": "A String", # Reply-to address.
+ "subject": "A String", # Subject of the email.
+ },
+ "verifyEmailTemplate": { # Template for an email template. # Verify email template.
+ "body": "A String", # Email body.
+ "fromDisplayName": "A String", # From display name.
+ "from": "A String", # From address of the email.
+ "format": "A String", # Email body format.
+ "replyTo": "A String", # Reply-to address.
+ "subject": "A String", # Subject of the email.
+ },
"allowPasswordUser": True or False, # Whether to allow password user sign in or sign up.
+ "changeEmailTemplate": { # Template for an email template. # Change email template.
+ "body": "A String", # Email body.
+ "fromDisplayName": "A String", # From display name.
+ "from": "A String", # From address of the email.
+ "format": "A String", # Email body format.
+ "replyTo": "A String", # Reply-to address.
+ "subject": "A String", # Subject of the email.
+ },
"idpConfig": [ # OAuth2 provider configuration.
{ # Template for a single idp configuration.
"experimentPercent": 42, # Percent of users who will be prompted/redirected federated login for this IDP.
+ "secret": "A String", # OAuth2 client secret.
"enabled": True or False, # Whether this IDP is enabled.
"clientId": "A String", # OAuth2 client ID.
"provider": "A String", # OAuth2 provider.
@@ -403,7 +450,9 @@
{ # Request to set the account information.
"instanceId": "A String", # Instance id token of the app.
"delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
- "displayName": "A String", # The name of the user.
+ "deleteAttribute": [ # The attributes users request to delete.
+ "A String",
+ ],
"localId": "A String", # The local ID of the user.
"validSince": "A String", # Timestamp in seconds for valid login token.
"photoUrl": "A String", # The photo url of the user.
@@ -414,11 +463,16 @@
],
"upgradeToFederatedLogin": True or False, # Mark the user to upgrade to federated login.
"disableUser": True or False, # Whether to disable the user.
+ "deleteProvider": [ # The IDPs the user request to delete.
+ "A String",
+ ],
"captchaChallenge": "A String", # The captcha challenge.
"idToken": "A String", # The GITKit token of the authenticated user.
- "oobCode": "A String", # The out-of-band code of the change email request.
+ "returnSecureToken": True or False, # Whether return sts id token and refresh token instead of gitkit token.
+ "displayName": "A String", # The name of the user.
"password": "A String", # The new password of the user.
"email": "A String", # The email of the user.
+ "oobCode": "A String", # The out-of-band code of the change email request.
}
@@ -426,23 +480,97 @@
An object of the form:
{ # Respone of setting the account information.
+ "expiresIn": "A String", # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
"kind": "identitytoolkit#SetAccountInfoResponse", # The fixed string "identitytoolkit#SetAccountInfoResponse".
"displayName": "A String", # The name of the user.
+ "localId": "A String", # The local ID of the user.
+ "photoUrl": "A String", # The photo url of the user.
+ "idToken": "A String", # The Gitkit id token to login the newly sign up user.
+ "passwordHash": "A String", # The user's hashed password.
+ "newEmail": "A String", # The new email the user attempts to change to.
+ "refreshToken": "A String", # If idToken is STS id token, then this field will be refresh token.
"providerUserInfo": [ # The user's profiles at the associated IdPs.
{
+ "federatedId": "A String", # User's identifier at IDP.
"providerId": "A String", # The IdP ID. For whitelisted IdPs it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
"displayName": "A String", # The user's display name at the IDP.
"photoUrl": "A String", # The user's photo url at the IDP.
},
],
- "photoUrl": "A String", # The photo url of the user.
- "idToken": "A String", # The Gitkit id token to login the newly sign up user.
- "newEmail": "A String", # The new email the user attempts to change to.
"email": "A String", # The email of the user.
}</pre>
</div>
<div class="method">
+ <code class="details" id="setProjectConfig">setProjectConfig(body)</code>
+ <pre>Set project configuration.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request to set the project configuration.
+ "apiKey": "A String", # Browser API key, needed when making http request to Apiary.
+ "useEmailSending": True or False, # Whether to use email sending provided by Firebear.
+ "verifyEmailTemplate": { # Template for an email template. # Verify email template.
+ "body": "A String", # Email body.
+ "fromDisplayName": "A String", # From display name.
+ "from": "A String", # From address of the email.
+ "format": "A String", # Email body format.
+ "replyTo": "A String", # Reply-to address.
+ "subject": "A String", # Subject of the email.
+ },
+ "enableAnonymousUser": True or False, # Whether to enable anonymous user.
+ "authorizedDomains": [ # Authorized domains for widget redirect.
+ "A String",
+ ],
+ "resetPasswordTemplate": { # Template for an email template. # Reset password email template.
+ "body": "A String", # Email body.
+ "fromDisplayName": "A String", # From display name.
+ "from": "A String", # From address of the email.
+ "format": "A String", # Email body format.
+ "replyTo": "A String", # Reply-to address.
+ "subject": "A String", # Subject of the email.
+ },
+ "legacyResetPasswordTemplate": { # Template for an email template. # Legacy reset password email template.
+ "body": "A String", # Email body.
+ "fromDisplayName": "A String", # From display name.
+ "from": "A String", # From address of the email.
+ "format": "A String", # Email body format.
+ "replyTo": "A String", # Reply-to address.
+ "subject": "A String", # Subject of the email.
+ },
+ "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
+ "allowPasswordUser": True or False, # Whether to allow password user sign in or sign up.
+ "changeEmailTemplate": { # Template for an email template. # Change email template.
+ "body": "A String", # Email body.
+ "fromDisplayName": "A String", # From display name.
+ "from": "A String", # From address of the email.
+ "format": "A String", # Email body format.
+ "replyTo": "A String", # Reply-to address.
+ "subject": "A String", # Subject of the email.
+ },
+ "idpConfig": [ # Oauth2 provider configuration.
+ { # Template for a single idp configuration.
+ "experimentPercent": 42, # Percent of users who will be prompted/redirected federated login for this IDP.
+ "secret": "A String", # OAuth2 client secret.
+ "enabled": True or False, # Whether this IDP is enabled.
+ "clientId": "A String", # OAuth2 client ID.
+ "provider": "A String", # OAuth2 provider.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # Response of setting the project configuration.
+ "projectId": "A String", # Project ID of the relying party.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="signOutUser">signOutUser(body)</code>
<pre>Sign out user.
@@ -487,9 +615,12 @@
An object of the form:
{ # Response of signing up new user, creating anonymous user or anonymous user reauth.
- "idToken": "A String", # The Gitkit id token to login the newly sign up user.
+ "expiresIn": "A String", # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
"kind": "identitytoolkit#SignupNewUserResponse", # The fixed string "identitytoolkit#SignupNewUserResponse".
"displayName": "A String", # The name of the user.
+ "localId": "A String", # The RP local ID of the user.
+ "idToken": "A String", # The Gitkit id token to login the newly sign up user.
+ "refreshToken": "A String", # If idToken is STS id token, then this field will be refresh token.
"email": "A String", # The email of the user.
}</pre>
</div>
@@ -518,10 +649,11 @@
"providerUserInfo": [ # The IDP of the user.
{
"federatedId": "A String", # User's identifier at IDP.
- "providerId": "A String", # The IdP ID. For white listed IdPs it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
"displayName": "A String", # The user's display name at the IDP.
- "email": "A String", # User's email at IDP.
"photoUrl": "A String", # The user's photo url at the IDP.
+ "providerId": "A String", # The IdP ID. For white listed IdPs it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
+ "rawId": "A String", # User's raw identifier directly returned from IDP.
+ "email": "A String", # User's email at IDP.
},
],
"passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.
@@ -566,6 +698,7 @@
"pendingIdToken": "A String", # The GITKit token for the non-trusted IDP pending to be confirmed by the user.
"sessionId": "A String", # Session ID, which should match the one in previous createAuthUri request.
"requestUri": "A String", # The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP.
+ "returnSecureToken": True or False, # Whether return sts id token and refresh token instead of gitkit token.
"returnRefreshToken": True or False, # Whether to return refresh tokens.
}
@@ -579,6 +712,8 @@
"photoUrl": "A String", # The URI of the public accessible profiel picture.
"inputEmail": "A String", # It's the identifier param in the createAuthUri request if the identifier is an email. It can be used to check whether the user input email is different from the asserted email.
"appScheme": "A String", # The custom scheme used by mobile app.
+ "expiresIn": "A String", # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
+ "refreshToken": "A String", # If idToken is STS id token, then this field will be refresh token.
"verifiedProvider": [ # When action is 'map', contains the idps which can be used for confirmation.
"A String",
],
@@ -587,8 +722,10 @@
"nickName": "A String", # The nick name of the user.
"email": "A String", # The email returned by the IdP. NOTE: The federated login user may not own the email.
"oauthAccessToken": "A String", # The OAuth2 access token.
+ "oauthTokenSecret": "A String", # The OAuth1 access token secret.
"language": "A String", # The language preference of the user.
"needConfirmation": True or False, # Whether the assertion is from a non-trusted IDP and need account linking confirmation.
+ "oauthIdToken": "A String", # The OIDC id token.
"fullName": "A String", # The full name of the user.
"kind": "identitytoolkit#VerifyAssertionResponse", # The fixed string "identitytoolkit#VerifyAssertionResponse".
"idToken": "A String", # The ID token.
@@ -620,7 +757,9 @@
{ # Request to verify a custom token
"instanceId": "A String", # Instance id token of the app.
+ "returnSecureToken": True or False, # Whether return sts id token and refresh token instead of gitkit token.
"token": "A String", # The custom token to verify
+ "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
}
@@ -628,8 +767,10 @@
An object of the form:
{ # Response from verifying a custom token
+ "expiresIn": "A String", # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
"idToken": "A String", # The GITKit token for authenticated user.
"kind": "identitytoolkit#VerifyCustomTokenResponse", # The fixed string "identitytoolkit#VerifyCustomTokenResponse".
+ "refreshToken": "A String", # If idToken is STS id token, then this field will be refresh token.
}</pre>
</div>
@@ -648,6 +789,7 @@
"idToken": "A String", # The GITKit token of the authenticated user.
"pendingIdToken": "A String", # The GITKit token for the non-trusted IDP, which is to be confirmed by the user.
"captchaChallenge": "A String", # The captcha challenge.
+ "returnSecureToken": True or False, # Whether return sts id token and refresh token instead of gitkit token.
"password": "A String", # The password inputed by the user.
"email": "A String", # The email of the user.
}
@@ -657,6 +799,7 @@
An object of the form:
{ # Request of verifying the password.
+ "expiresIn": "A String", # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
"kind": "identitytoolkit#VerifyPasswordResponse", # The fixed string "identitytoolkit#VerifyPasswordResponse".
"displayName": "A String", # The name of the user.
"localId": "A String", # The RP local ID if it's already been mapped to the IdP account identified by the federated ID.
@@ -666,6 +809,7 @@
"idToken": "A String", # The GITKit token for authenticated user.
"registered": True or False, # Whether the email is registered.
"oauthAuthorizationCode": "A String", # The OAuth2 authorization code.
+ "refreshToken": "A String", # If idToken is STS id token, then this field will be refresh token.
"email": "A String", # The email returned by the IdP. NOTE: The federated login user may not own the email.
}</pre>
</div>