File: oauth2_v1.html

package info (click to toggle)
python-googleapi 1.5.5-1
  • links: PTS
  • area: main
  • in suites: buster, stretch
  • size: 39,832 kB
  • ctags: 5,921
  • sloc: python: 7,176; makefile: 64; sh: 53; xml: 5
file content (244 lines) | stat: -rw-r--r-- 6,449 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="oauth2_v1.html">Google OAuth2 API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="oauth2_v1.userinfo.html">userinfo()</a></code>
</p>
<p class="firstline">Returns the userinfo Resource.</p>

<p class="toc_element">
  <code><a href="#getCertForOpenIdConnect">getCertForOpenIdConnect()</a></code></p>
<p class="firstline">A description of how to use this function</p>
<p class="toc_element">
  <code><a href="#getCertForOpenIdConnectRaw">getCertForOpenIdConnectRaw()</a></code></p>
<p class="firstline">A description of how to use this function</p>
<p class="toc_element">
  <code><a href="#getRobotJwk">getRobotJwk(robotEmail)</a></code></p>
<p class="firstline">A description of how to use this function</p>
<p class="toc_element">
  <code><a href="#getRobotMetadataRaw">getRobotMetadataRaw(robotEmail)</a></code></p>
<p class="firstline">A description of how to use this function</p>
<p class="toc_element">
  <code><a href="#getRobotMetadataX509">getRobotMetadataX509(robotEmail)</a></code></p>
<p class="firstline">A description of how to use this function</p>
<p class="toc_element">
  <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
<p class="toc_element">
  <code><a href="#tokeninfo">tokeninfo(access_token=None, id_token=None)</a></code></p>
<p class="firstline">Get token info</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="getCertForOpenIdConnect">getCertForOpenIdConnect()</code>
  <pre>A description of how to use this function

Args:

Returns:
  An object of the form:

    {
    "a_key": "A String",
  }</pre>
</div>

<div class="method">
    <code class="details" id="getCertForOpenIdConnectRaw">getCertForOpenIdConnectRaw()</code>
  <pre>A description of how to use this function

Args:

Returns:
  An object of the form:

    {
    "keyvalues": [
      {
        "keyid": "A String",
        "modulus": "A String",
        "exponent": "A String",
        "algorithm": "RSA",
      },
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="getRobotJwk">getRobotJwk(robotEmail)</code>
  <pre>A description of how to use this function

Args:
  robotEmail: string, The email of robot account. (required)

Returns:
  An object of the form:

    {
    "keys": [
      {
        "use": "sig",
        "e": "A String",
        "kty": "RSA",
        "alg": "RS256",
        "n": "A String",
        "kid": "A String",
      },
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="getRobotMetadataRaw">getRobotMetadataRaw(robotEmail)</code>
  <pre>A description of how to use this function

Args:
  robotEmail: string, The email of robot account. (required)

Returns:
  An object of the form:

    {
    "keyvalues": [
      {
        "keyid": "A String",
        "modulus": "A String",
        "exponent": "A String",
        "algorithm": "RSA",
      },
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="getRobotMetadataX509">getRobotMetadataX509(robotEmail)</code>
  <pre>A description of how to use this function

Args:
  robotEmail: string, The email of robot account. (required)

Returns:
  An object of the form:

    {
    "a_key": "A String",
  }</pre>
</div>

<div class="method">
    <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
  <pre>Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
        </pre>
</div>

<div class="method">
    <code class="details" id="tokeninfo">tokeninfo(access_token=None, id_token=None)</code>
  <pre>Get token info

Args:
  access_token: string, The oauth2 access token
  id_token: string, The ID token

Returns:
  An object of the form:

    {
    "issued_to": "A String", # To whom was the token issued to. In general the same as audience.
    "nonce": "A String", # Nonce of the id token.
    "user_id": "A String", # The obfuscated user id.
    "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.
    "expires_in": 42, # The expiry time of the token, as number of seconds left until expiry.
    "access_type": "A String", # The access type granted with this token. It can be offline or online.
    "audience": "A String", # Who is the intended audience for this token. In general the same as issued_to.
    "issued_at": 42, # The issue time of the token, as number of seconds.
    "scope": "A String", # The space separated list of scopes granted to this token.
    "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.
    "email": "A String", # The email address of the user. Present only if the email scope is present in the request.
    "issuer": "A String", # Who issued the token.
  }</pre>
</div>

</body></html>