v2.d.ts
13.6 KB
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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace oauth2_v2 {
export interface Options extends GlobalOptions {
version: 'v2';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* Data format for the response.
*/
alt?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
* Deprecated. Please use quotaUser instead.
*/
userIp?: string;
}
/**
* Google OAuth2 API
*
* Obtains end-user authorization grants for use with other Google APIs.
*
* @example
* ```js
* const {google} = require('googleapis');
* const oauth2 = google.oauth2('v2');
* ```
*/
export class Oauth2 {
context: APIRequestContext;
userinfo: Resource$Userinfo;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
/**
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/oauth2.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const oauth2 = google.oauth2('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await oauth2.tokeninfo({
* access_token: 'placeholder-value',
*
* id_token: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "audience": "my_audience",
* // "email": "my_email",
* // "expires_in": 0,
* // "issued_to": "my_issued_to",
* // "scope": "my_scope",
* // "user_id": "my_user_id",
* // "verified_email": false
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
tokeninfo(params: Params$$Tokeninfo, options: StreamMethodOptions): GaxiosPromise<Readable>;
tokeninfo(params?: Params$$Tokeninfo, options?: MethodOptions): GaxiosPromise<Schema$Tokeninfo>;
tokeninfo(params: Params$$Tokeninfo, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
tokeninfo(params: Params$$Tokeninfo, options: MethodOptions | BodyResponseCallback<Schema$Tokeninfo>, callback: BodyResponseCallback<Schema$Tokeninfo>): void;
tokeninfo(params: Params$$Tokeninfo, callback: BodyResponseCallback<Schema$Tokeninfo>): void;
tokeninfo(callback: BodyResponseCallback<Schema$Tokeninfo>): void;
}
export interface Schema$Tokeninfo {
/**
* Who is the intended audience for this token. In general the same as issued_to.
*/
audience?: string | null;
/**
* The email address of the user. Present only if the email scope is present in the request.
*/
email?: string | null;
/**
* The expiry time of the token, as number of seconds left until expiry.
*/
expires_in?: number | null;
/**
* To whom was the token issued to. In general the same as audience.
*/
issued_to?: string | null;
/**
* The space separated list of scopes granted to this token.
*/
scope?: string | null;
/**
* The obfuscated user id.
*/
user_id?: string | null;
/**
* Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request.
*/
verified_email?: boolean | null;
}
export interface Schema$Userinfo {
/**
* The user's email address.
*/
email?: string | null;
/**
* The user's last name.
*/
family_name?: string | null;
/**
* The user's gender.
*/
gender?: string | null;
/**
* The user's first name.
*/
given_name?: string | null;
/**
* The hosted domain e.g. example.com if the user is Google apps user.
*/
hd?: string | null;
/**
* The obfuscated ID of the user.
*/
id?: string | null;
/**
* URL of the profile page.
*/
link?: string | null;
/**
* The user's preferred locale.
*/
locale?: string | null;
/**
* The user's full name.
*/
name?: string | null;
/**
* URL of the user's picture image.
*/
picture?: string | null;
/**
* Boolean flag which is true if the email address is verified. Always verified because we only return the user's primary email address.
*/
verified_email?: boolean | null;
}
export interface Params$$Tokeninfo extends StandardParameters {
/**
*
*/
access_token?: string;
/**
*
*/
id_token?: string;
}
export class Resource$Userinfo {
context: APIRequestContext;
v2: Resource$Userinfo$V2;
constructor(context: APIRequestContext);
/**
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/oauth2.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const oauth2 = google.oauth2('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'openid',
* 'https://www.googleapis.com/auth/userinfo.email',
* 'https://www.googleapis.com/auth/userinfo.profile',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await oauth2.userinfo.get({});
* console.log(res.data);
*
* // Example response
* // {
* // "email": "my_email",
* // "family_name": "my_family_name",
* // "gender": "my_gender",
* // "given_name": "my_given_name",
* // "hd": "my_hd",
* // "id": "my_id",
* // "link": "my_link",
* // "locale": "my_locale",
* // "name": "my_name",
* // "picture": "my_picture",
* // "verified_email": false
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Userinfo$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Userinfo$Get, options?: MethodOptions): GaxiosPromise<Schema$Userinfo>;
get(params: Params$Resource$Userinfo$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Userinfo$Get, options: MethodOptions | BodyResponseCallback<Schema$Userinfo>, callback: BodyResponseCallback<Schema$Userinfo>): void;
get(params: Params$Resource$Userinfo$Get, callback: BodyResponseCallback<Schema$Userinfo>): void;
get(callback: BodyResponseCallback<Schema$Userinfo>): void;
}
export interface Params$Resource$Userinfo$Get extends StandardParameters {
}
export class Resource$Userinfo$V2 {
context: APIRequestContext;
me: Resource$Userinfo$V2$Me;
constructor(context: APIRequestContext);
}
export class Resource$Userinfo$V2$Me {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/oauth2.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const oauth2 = google.oauth2('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'openid',
* 'https://www.googleapis.com/auth/userinfo.email',
* 'https://www.googleapis.com/auth/userinfo.profile',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await oauth2.userinfo.v2.me.get({});
* console.log(res.data);
*
* // Example response
* // {
* // "email": "my_email",
* // "family_name": "my_family_name",
* // "gender": "my_gender",
* // "given_name": "my_given_name",
* // "hd": "my_hd",
* // "id": "my_id",
* // "link": "my_link",
* // "locale": "my_locale",
* // "name": "my_name",
* // "picture": "my_picture",
* // "verified_email": false
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Userinfo$V2$Me$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Userinfo$V2$Me$Get, options?: MethodOptions): GaxiosPromise<Schema$Userinfo>;
get(params: Params$Resource$Userinfo$V2$Me$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Userinfo$V2$Me$Get, options: MethodOptions | BodyResponseCallback<Schema$Userinfo>, callback: BodyResponseCallback<Schema$Userinfo>): void;
get(params: Params$Resource$Userinfo$V2$Me$Get, callback: BodyResponseCallback<Schema$Userinfo>): void;
get(callback: BodyResponseCallback<Schema$Userinfo>): void;
}
export interface Params$Resource$Userinfo$V2$Me$Get extends StandardParameters {
}
export {};
}