blob: d17668f40f51d0ee3d45152d8c0c1d36680afbf0 [file] [log] [blame] [edit]
<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.accounts.html">accounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="identitytoolkit_v2.accounts.mfaEnrollment.html">mfaEnrollment()</a></code>
</p>
<p class="firstline">Returns the mfaEnrollment Resource.</p>
<p class="toc_element">
<code><a href="identitytoolkit_v2.accounts.mfaSignIn.html">mfaSignIn()</a></code>
</p>
<p class="firstline">Returns the mfaSignIn 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="#revokeToken">revokeToken(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Revokes a user's token from an Identity Provider (IdP). This is done by manually providing an IdP credential, and the token types for revocation. 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>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="revokeToken">revokeToken(body=None, x__xgafv=None)</code>
<pre>Revokes a user&#x27;s token from an Identity Provider (IdP). This is done by manually providing an IdP credential, and the token types for revocation. 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.
The object takes the form of:
{ # Request message for RevokeToken.
&quot;idToken&quot;: &quot;A String&quot;, # Required. A valid Identity Platform ID token to link the account. If there was a successful token revocation request on the account and no tokens are generated after the revocation, the duplicate requests will be ignored and returned immediately.
&quot;providerId&quot;: &quot;A String&quot;, # Required. The idp provider for the token. Currently only supports Apple Idp. The format should be &quot;apple.com&quot;.
&quot;redirectUri&quot;: &quot;A String&quot;, # The redirect URI provided in the initial authorization request made by the client to the IDP. The URI must use the HTTPS protocol, include a domain name, and can&#x27;t contain an IP address or localhost. Required if token_type is CODE.
&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.
&quot;token&quot;: &quot;A String&quot;, # Required. The token to be revoked. If an authorization_code is passed in, the API will first exchange the code for access token and then revoke the token exchanged.
&quot;tokenType&quot;: &quot;A String&quot;, # Required. The type of the token to be revoked.
}
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 RevokeToken. Empty for now.
}</pre>
</div>
</body></html>