Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 2f245374da9c895dbd8bb0423e98707d51b53414 / . / docs / dyn / oauth2_v1.html
blob: 367e0c2862c54781f075750ede7442128e1c3e8c [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1<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">
83 <code><a href="#getCertForOpenIdConnect">getCertForOpenIdConnect()</a></code></p>
84<p class="firstline">A description of how to use this function</p>
85<p class="toc_element">
86 <code><a href="#getCertForOpenIdConnectRaw">getCertForOpenIdConnectRaw()</a></code></p>
87<p class="firstline">A description of how to use this function</p>
88<p class="toc_element">
89 <code><a href="#getRobotJwk">getRobotJwk(robotEmail)</a></code></p>
90<p class="firstline">A description of how to use this function</p>
91<p class="toc_element">
92 <code><a href="#getRobotMetadataRaw">getRobotMetadataRaw(robotEmail)</a></code></p>
93<p class="firstline">A description of how to use this function</p>
94<p class="toc_element">
95 <code><a href="#getRobotMetadataX509">getRobotMetadataX509(robotEmail)</a></code></p>
96<p class="firstline">A description of how to use this function</p>
97<p class="toc_element">
98 <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
99<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
100<p class="toc_element">
101 <code><a href="#tokeninfo">tokeninfo(access_token=None, id_token=None)</a></code></p>
102<p class="firstline">Get token info</p>
103<h3>Method Details</h3>
104<div class="method">
105 <code class="details" id="getCertForOpenIdConnect">getCertForOpenIdConnect()</code>
106 <pre>A description of how to use this function
107
108Args:
109
110Returns:
111 An object of the form:
112
113 {
114 "a_key": "A String",
115 }</pre>
116</div>
117
118<div class="method">
119 <code class="details" id="getCertForOpenIdConnectRaw">getCertForOpenIdConnectRaw()</code>
120 <pre>A description of how to use this function
121
122Args:
123
124Returns:
125 An object of the form:
126
127 {
128 "keyvalues": [
129 {
130 "keyid": "A String",
131 "modulus": "A String",
132 "exponent": "A String",
133 "algorithm": "RSA",
134 },
135 ],
136 }</pre>
137</div>
138
139<div class="method">
140 <code class="details" id="getRobotJwk">getRobotJwk(robotEmail)</code>
141 <pre>A description of how to use this function
142
143Args:
144 robotEmail: string, The email of robot account. (required)
145
146Returns:
147 An object of the form:
148
149 {
150 "keys": [
151 {
152 "use": "sig",
153 "e": "A String",
154 "kty": "RSA",
155 "alg": "RS256",
156 "n": "A String",
157 "kid": "A String",
158 },
159 ],
160 }</pre>
161</div>
162
163<div class="method">
164 <code class="details" id="getRobotMetadataRaw">getRobotMetadataRaw(robotEmail)</code>
165 <pre>A description of how to use this function
166
167Args:
168 robotEmail: string, The email of robot account. (required)
169
170Returns:
171 An object of the form:
172
173 {
174 "keyvalues": [
175 {
176 "keyid": "A String",
177 "modulus": "A String",
178 "exponent": "A String",
179 "algorithm": "RSA",
180 },
181 ],
182 }</pre>
183</div>
184
185<div class="method">
186 <code class="details" id="getRobotMetadataX509">getRobotMetadataX509(robotEmail)</code>
187 <pre>A description of how to use this function
188
189Args:
190 robotEmail: string, The email of robot account. (required)
191
192Returns:
193 An object of the form:
194
195 {
196 "a_key": "A String",
197 }</pre>
198</div>
199
200<div class="method">
201 <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
202 <pre>Create a BatchHttpRequest object based on the discovery document.
203
204 Args:
205 callback: callable, A callback to be called for each response, of the
206 form callback(id, response, exception). The first parameter is the
207 request id, and the second is the deserialized response object. The
208 third is an apiclient.errors.HttpError exception object if an HTTP
209 error occurred while processing the request, or None if no error
210 occurred.
211
212 Returns:
213 A BatchHttpRequest object based on the discovery document.
214 </pre>
215</div>
216
217<div class="method">
218 <code class="details" id="tokeninfo">tokeninfo(access_token=None, id_token=None)</code>
219 <pre>Get token info
220
221Args:
222 access_token: string, The oauth2 access token
223 id_token: string, The ID token
224
225Returns:
226 An object of the form:
227
228 {
229 "issued_to": "A String", # To whom was the token issued to. In general the same as audience.
230 "nonce": "A String", # Nonce of the id token.
231 "user_id": "A String", # The obfuscated user id.
232 "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.
233 "expires_in": 42, # The expiry time of the token, as number of seconds left until expiry.
234 "access_type": "A String", # The access type granted with this token. It can be offline or online.
235 "audience": "A String", # Who is the intended audience for this token. In general the same as issued_to.
236 "issued_at": 42, # The issue time of the token, as number of seconds.
237 "scope": "A String", # The space separated list of scopes granted to this token.
238 "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.
239 "email": "A String", # The email address of the user. Present only if the email scope is present in the request.
240 "issuer": "A String", # Who issued the token.
241 }</pre>
242</div>
243
244</body></html>