blob: 66e9d2e7456ea4465f0551a0deef128edd92ac67 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001<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_v1.html">Google OAuth2 API</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="oauth2_v1.userinfo.html">userinfo()</a></code>
79</p>
80<p class="firstline">Returns the userinfo Resource.</p>
81
82<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -070083 <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">
86 <code><a href="#tokeninfo">tokeninfo(access_token=None, id_token=None)</a></code></p>
87<p class="firstline">Get token info</p>
88<h3>Method Details</h3>
89<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -070090 <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">
107 <code class="details" id="tokeninfo">tokeninfo(access_token=None, id_token=None)</code>
108 <pre>Get token info
109
110Args:
111 access_token: string, The oauth2 access token
112 id_token: string, The ID token
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.
119 "nonce": "A String", # Nonce of the id token.
120 "user_id": "A String", # The obfuscated user id.
121 "email_verified": 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.
122 "expires_in": 42, # The expiry time of the token, as number of seconds left until expiry.
123 "access_type": "A String", # The access type granted with this token. It can be offline or online.
124 "audience": "A String", # Who is the intended audience for this token. In general the same as issued_to.
125 "issued_at": 42, # The issue time of the token, as number of seconds.
126 "scope": "A String", # The space separated list of scopes granted to this token.
127 "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.
128 "email": "A String", # The email address of the user. Present only if the email scope is present in the request.
129 "issuer": "A String", # Who issued the token.
130 }</pre>
131</div>
132
133</body></html>