blob: f56acb7dcf7fd03330631adf6eb43bff71629a42 [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">
Craig Citroe633be12015-03-02 13:40:36 -080083 <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">
John Asmuth614db982014-04-24 15:46:26 -040086 <code><a href="#tokeninfo">tokeninfo(access_token=None, id_token=None)</a></code></p>
87<p class="firstline">A description of how to use this function</p>
88<h3>Method Details</h3>
89<div class="method">
Craig Citroe633be12015-03-02 13:40:36 -080090 <code class="details" id="getCertForOpenIdConnect">getCertForOpenIdConnect()</code>
91 <pre>A description of how to use this function
92
93Args:
94
95Returns:
96 An object of the form:
97
98 {
99 "keys": [
100 {
101 "use": "sig",
102 "e": "A String",
103 "kty": "RSA",
104 "alg": "RS256",
105 "n": "A String",
106 "kid": "A String",
107 },
108 ],
109 }</pre>
110</div>
111
112<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400113 <code class="details" id="tokeninfo">tokeninfo(access_token=None, id_token=None)</code>
114 <pre>A description of how to use this function
115
116Args:
117 access_token: string, A parameter
118 id_token: string, A parameter
119
120Returns:
121 An object of the form:
122
123 {
124 "issued_to": "A String", # To whom was the token issued to. In general the same as audience.
125 "user_id": "A String", # The Gaia obfuscated user id.
126 "expires_in": 42, # The expiry time of the token, as number of seconds left until expiry.
127 "access_type": "A String", # The access type granted with this token. It can be offline or online.
128 "audience": "A String", # Who is the intended audience for this token. In general the same as issued_to.
129 "scope": "A String", # The space separated list of scopes granted to this token.
130 "email": "A String", # The email address of the user. Present only if the email scope is present in the request.
131 "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.
132 }</pre>
133</div>
134
135</body></html>