Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4f877e562986034f25ea4246ad1256eabd339526 / . / docs / dyn / oauth2_v2.html
blob: d69da45244128999debc479ff01ac74e6d881986 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[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_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">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]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">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]86 <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
87<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
88<p class="toc_element">
89 <code><a href="#tokeninfo">tokeninfo(token_handle=None, access_token=None, id_token=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]90<p class="firstline">A description of how to use this function</p>
91<h3>Method Details</h3>
92<div class="method">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]93 <code class="details" id="getCertForOpenIdConnect">getCertForOpenIdConnect()</code>
94 <pre>A description of how to use this function
95
96Args:
97
98Returns:
99 An object of the form:
100
101 {
102 "keys": [
103 {
104 "use": "sig",
105 "e": "A String",
106 "kty": "RSA",
107 "alg": "RS256",
108 "n": "A String",
109 "kid": "A String",
110 },
111 ],
112 }</pre>
113</div>
114
115<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]116 <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
117 <pre>Create a BatchHttpRequest object based on the discovery document.
118
119 Args:
120 callback: callable, A callback to be called for each response, of the
121 form callback(id, response, exception). The first parameter is the
122 request id, and the second is the deserialized response object. The
123 third is an apiclient.errors.HttpError exception object if an HTTP
124 error occurred while processing the request, or None if no error
125 occurred.
126
127 Returns:
128 A BatchHttpRequest object based on the discovery document.
129 </pre>
130</div>
131
132<div class="method">
133 <code class="details" id="tokeninfo">tokeninfo(token_handle=None, access_token=None, id_token=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]134 <pre>A description of how to use this function
135
136Args:
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]137 token_handle: string, A parameter
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]138 access_token: string, A parameter
139 id_token: string, A parameter
140
141Returns:
142 An object of the form:
143
144 {
145 "issued_to": "A String", # To whom was the token issued to. In general the same as audience.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]146 "token_handle": "A String", # The token handle associated with this token.
147 "user_id": "A String", # The obfuscated user id.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]148 "expires_in": 42, # The expiry time of the token, as number of seconds left until expiry.
149 "access_type": "A String", # The access type granted with this token. It can be offline or online.
150 "audience": "A String", # Who is the intended audience for this token. In general the same as issued_to.
151 "scope": "A String", # The space separated list of scopes granted to this token.
152 "email": "A String", # The email address of the user. Present only if the email scope is present in the request.
153 "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.
154 }</pre>
155</div>
156
157</body></html>