v1.d.ts
9.43 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
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace oauth2_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* 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
* const {google} = require('googleapis');
* const oauth2 = google.oauth2('v1');
*
* @namespace oauth2
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Oauth2
*/
export class Oauth2 {
context: APIRequestContext;
userinfo: Resource$Userinfo;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
/**
* oauth2.tokeninfo
* @desc Get token info
* @alias oauth2.tokeninfo
* @memberOf! oauth2(v1)
*
* @param {object=} params Parameters for request
* @param {string=} params.access_token The oauth2 access token
* @param {string=} params.id_token The ID token
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
tokeninfo(params?: Params$$Tokeninfo, options?: MethodOptions): GaxiosPromise<Schema$Tokeninfo>;
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 {
/**
* The access type granted with this token. It can be offline or online.
*/
access_type?: string | null;
/**
* 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;
/**
* Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request.
*/
email_verified?: boolean | null;
/**
* The expiry time of the token, as number of seconds left until expiry.
*/
expires_in?: number | null;
/**
* The issue time of the token, as number of seconds.
*/
issued_at?: number | null;
/**
* To whom was the token issued to. In general the same as audience.
*/
issued_to?: string | null;
/**
* Who issued the token.
*/
issuer?: string | null;
/**
* Nonce of the id token.
*/
nonce?: 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$Userinfoplus {
/**
* 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 {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The oauth2 access token
*/
access_token?: string;
/**
* The ID token
*/
id_token?: string;
}
export class Resource$Userinfo {
context: APIRequestContext;
v2: Resource$Userinfo$V2;
constructor(context: APIRequestContext);
/**
* oauth2.userinfo.get
* @desc Get user info
* @alias oauth2.userinfo.get
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Userinfo$Get, options?: MethodOptions): GaxiosPromise<Schema$Userinfoplus>;
get(params: Params$Resource$Userinfo$Get, options: MethodOptions | BodyResponseCallback<Schema$Userinfoplus>, callback: BodyResponseCallback<Schema$Userinfoplus>): void;
get(params: Params$Resource$Userinfo$Get, callback: BodyResponseCallback<Schema$Userinfoplus>): void;
get(callback: BodyResponseCallback<Schema$Userinfoplus>): void;
}
export interface Params$Resource$Userinfo$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
}
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);
/**
* oauth2.userinfo.v2.me.get
* @desc Get user info
* @alias oauth2.userinfo.v2.me.get
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Userinfo$V2$Me$Get, options?: MethodOptions): GaxiosPromise<Schema$Userinfoplus>;
get(params: Params$Resource$Userinfo$V2$Me$Get, options: MethodOptions | BodyResponseCallback<Schema$Userinfoplus>, callback: BodyResponseCallback<Schema$Userinfoplus>): void;
get(params: Params$Resource$Userinfo$V2$Me$Get, callback: BodyResponseCallback<Schema$Userinfoplus>): void;
get(callback: BodyResponseCallback<Schema$Userinfoplus>): void;
}
export interface Params$Resource$Userinfo$V2$Me$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
}
export {};
}