blob: d62a36e0fffaa0bb20c3e36f2fa3e91955be71a0 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="oauth2_v2.html">Google OAuth2 API</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="oauth2_v2.userinfo.html">userinfo()</a></code>
79</p>
80<p class="firstline">Returns the userinfo Resource.</p>
81
82<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +000083 <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
84<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
85<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070086 <code><a href="#tokeninfo">tokeninfo(access_token=None, id_token=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040087<p class="firstline">A description of how to use this function</p>
88<h3>Method Details</h3>
89<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +000090 <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
91 <pre>Create a BatchHttpRequest object based on the discovery document.
92
93 Args:
94 callback: callable, A callback to be called for each response, of the
95 form callback(id, response, exception). The first parameter is the
96 request id, and the second is the deserialized response object. The
97 third is an apiclient.errors.HttpError exception object if an HTTP
98 error occurred while processing the request, or None if no error
99 occurred.
100
101 Returns:
102 A BatchHttpRequest object based on the discovery document.
103 </pre>
104</div>
105
106<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700107 <code class="details" id="tokeninfo">tokeninfo(access_token=None, id_token=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400108 <pre>A description of how to use this function
109
110Args:
111 access_token: string, A parameter
112 id_token: string, A parameter
113
114Returns:
115 An object of the form:
116
117 {
118 "issued_to": "A String", # To whom was the token issued to. In general the same as audience.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000119 "user_id": "A String", # The obfuscated user id.
John Asmuth614db982014-04-24 15:46:26 -0400120 "expires_in": 42, # The expiry time of the token, as number of seconds left until expiry.
John Asmuth614db982014-04-24 15:46:26 -0400121 "audience": "A String", # Who is the intended audience for this token. In general the same as issued_to.
122 "scope": "A String", # The space separated list of scopes granted to this token.
123 "email": "A String", # The email address of the user. Present only if the email scope is present in the request.
124 "verified_email": True or False, # Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request.
125 }</pre>
126</div>
127
128</body></html>