v1.d.ts
22.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
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
/**
* 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 { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace iamcredentials_v1 {
interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: 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;
/**
* Available to use for quota purposes for server-side applications. Can be
* any arbitrary string assigned to a user, but should not exceed 40
* characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* IAM Service Account Credentials API
*
* Creates short-lived, limited-privilege credentials for IAM service
* accounts.
*
* @example
* const {google} = require('googleapis');
* const iamcredentials = google.iamcredentials('v1');
*
* @namespace iamcredentials
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Iamcredentials
*/
class Iamcredentials {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
interface Schema$GenerateAccessTokenRequest {
/**
* The sequence of service accounts in a delegation chain. Each service
* account must be granted the `roles/iam.serviceAccountTokenCreator` role
* on its next service account in the chain. The last service account in the
* chain must be granted the `roles/iam.serviceAccountTokenCreator` role on
* the service account that is specified in the `name` field of the request.
* The delegates must have the following format:
* `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-`
* wildcard character is required; replacing it with a project ID is
* invalid.
*/
delegates?: string[];
/**
* The desired lifetime duration of the access token in seconds. Must be set
* to a value less than or equal to 3600 (1 hour). If a value is not
* specified, the token's lifetime will be set to a default value of one
* hour.
*/
lifetime?: string;
/**
* Code to identify the scopes to be included in the OAuth 2.0 access token.
* See https://developers.google.com/identity/protocols/googlescopes for
* more information. At least one value required.
*/
scope?: string[];
}
interface Schema$GenerateAccessTokenResponse {
/**
* The OAuth 2.0 access token.
*/
accessToken?: string;
/**
* Token expiration time. The expiration time is always set.
*/
expireTime?: string;
}
interface Schema$GenerateIdentityBindingAccessTokenRequest {
/**
* Required. Input token. Must be in JWT format according to RFC7523
* (https://tools.ietf.org/html/rfc7523) and must have 'kid' field
* in the header. Supported signing algorithms: RS256 (RS512, ES256, ES512
* coming soon). Mandatory payload fields (along the lines of RFC 7523,
* section 3): - iss: issuer of the token. Must provide a discovery document
* at $iss/.well-known/openid-configuration . The document needs to
* be formatted according to section 4.2 of the OpenID Connect
* Discovery 1.0 specification. - iat: Issue time in seconds since
* epoch. Must be in the past. - exp: Expiration time in seconds since
* epoch. Must be less than 48 hours after iat. We recommend to
* create tokens that last shorter than 6 hours to improve security
* unless business reasons mandate longer expiration times. Shorter
* token lifetimes are generally more secure since tokens that have
* been exfiltrated by attackers can be used for a shorter time. you
* can configure the maximum lifetime of the incoming token in the
* configuration of the mapper. The resulting Google token will
* expire within an hour or at "exp", whichever is earlier.
* - sub: JWT subject, identity asserted in the JWT. - aud: Configured in
* the mapper policy. By default the service account email. Claims
* from the incoming token can be transferred into the output token accoding
* to the mapper configuration. The outgoing claim size is limited. Outgoing
* claims size must be less than 4kB serialized as JSON without whitespace.
* Example header: { "alg": "RS256", "kid":
* "92a4265e14ab04d4d228a48d10d4ca31610936f8" } Example payload: {
* "iss": "https://accounts.google.com",
* "iat": 1517963104, "exp": 1517966704,
* "aud":
* "https://iamcredentials.googleapis.com/google.iam.credentials.v1.CloudGaia",
* "sub": "113475438248934895348",
* "my_claims": { "additional_claim":
* "value" } }
*/
jwt?: string;
/**
* Code to identify the scopes to be included in the OAuth 2.0 access token.
* See https://developers.google.com/identity/protocols/googlescopes for
* more information. At least one value required.
*/
scope?: string[];
}
interface Schema$GenerateIdentityBindingAccessTokenResponse {
/**
* The OAuth 2.0 access token.
*/
accessToken?: string;
/**
* Token expiration time. The expiration time is always set.
*/
expireTime?: string;
}
interface Schema$GenerateIdTokenRequest {
/**
* The audience for the token, such as the API or account that this token
* grants access to.
*/
audience?: string;
/**
* The sequence of service accounts in a delegation chain. Each service
* account must be granted the `roles/iam.serviceAccountTokenCreator` role
* on its next service account in the chain. The last service account in the
* chain must be granted the `roles/iam.serviceAccountTokenCreator` role on
* the service account that is specified in the `name` field of the request.
* The delegates must have the following format:
* `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-`
* wildcard character is required; replacing it with a project ID is
* invalid.
*/
delegates?: string[];
/**
* Include the service account email in the token. If set to `true`, the
* token will contain `email` and `email_verified` claims.
*/
includeEmail?: boolean;
}
interface Schema$GenerateIdTokenResponse {
/**
* The OpenId Connect ID token.
*/
token?: string;
}
interface Schema$SignBlobRequest {
/**
* The sequence of service accounts in a delegation chain. Each service
* account must be granted the `roles/iam.serviceAccountTokenCreator` role
* on its next service account in the chain. The last service account in the
* chain must be granted the `roles/iam.serviceAccountTokenCreator` role on
* the service account that is specified in the `name` field of the request.
* The delegates must have the following format:
* `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-`
* wildcard character is required; replacing it with a project ID is
* invalid.
*/
delegates?: string[];
/**
* The bytes to sign.
*/
payload?: string;
}
interface Schema$SignBlobResponse {
/**
* The ID of the key used to sign the blob.
*/
keyId?: string;
/**
* The signed blob.
*/
signedBlob?: string;
}
interface Schema$SignJwtRequest {
/**
* The sequence of service accounts in a delegation chain. Each service
* account must be granted the `roles/iam.serviceAccountTokenCreator` role
* on its next service account in the chain. The last service account in the
* chain must be granted the `roles/iam.serviceAccountTokenCreator` role on
* the service account that is specified in the `name` field of the request.
* The delegates must have the following format:
* `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-`
* wildcard character is required; replacing it with a project ID is
* invalid.
*/
delegates?: string[];
/**
* The JWT payload to sign: a JSON object that contains a JWT Claims Set.
*/
payload?: string;
}
interface Schema$SignJwtResponse {
/**
* The ID of the key used to sign the JWT.
*/
keyId?: string;
/**
* The signed JWT.
*/
signedJwt?: string;
}
class Resource$Projects {
context: APIRequestContext;
serviceAccounts: Resource$Projects$Serviceaccounts;
constructor(context: APIRequestContext);
}
class Resource$Projects$Serviceaccounts {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* iamcredentials.projects.serviceAccounts.generateAccessToken
* @desc Generates an OAuth 2.0 access token for a service account.
* @alias iamcredentials.projects.serviceAccounts.generateAccessToken
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid.
* @param {().GenerateAccessTokenRequest} params.resource Request body data
* @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
*/
generateAccessToken(params?: Params$Resource$Projects$Serviceaccounts$Generateaccesstoken, options?: MethodOptions): GaxiosPromise<Schema$GenerateAccessTokenResponse>;
generateAccessToken(params: Params$Resource$Projects$Serviceaccounts$Generateaccesstoken, options: MethodOptions | BodyResponseCallback<Schema$GenerateAccessTokenResponse>, callback: BodyResponseCallback<Schema$GenerateAccessTokenResponse>): void;
generateAccessToken(params: Params$Resource$Projects$Serviceaccounts$Generateaccesstoken, callback: BodyResponseCallback<Schema$GenerateAccessTokenResponse>): void;
generateAccessToken(callback: BodyResponseCallback<Schema$GenerateAccessTokenResponse>): void;
/**
* iamcredentials.projects.serviceAccounts.generateIdentityBindingAccessToken
* @alias
* iamcredentials.projects.serviceAccounts.generateIdentityBindingAccessToken
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid.
* @param {().GenerateIdentityBindingAccessTokenRequest} params.resource Request body data
* @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
*/
generateIdentityBindingAccessToken(params?: Params$Resource$Projects$Serviceaccounts$Generateidentitybindingaccesstoken, options?: MethodOptions): GaxiosPromise<Schema$GenerateIdentityBindingAccessTokenResponse>;
generateIdentityBindingAccessToken(params: Params$Resource$Projects$Serviceaccounts$Generateidentitybindingaccesstoken, options: MethodOptions | BodyResponseCallback<Schema$GenerateIdentityBindingAccessTokenResponse>, callback: BodyResponseCallback<Schema$GenerateIdentityBindingAccessTokenResponse>): void;
generateIdentityBindingAccessToken(params: Params$Resource$Projects$Serviceaccounts$Generateidentitybindingaccesstoken, callback: BodyResponseCallback<Schema$GenerateIdentityBindingAccessTokenResponse>): void;
generateIdentityBindingAccessToken(callback: BodyResponseCallback<Schema$GenerateIdentityBindingAccessTokenResponse>): void;
/**
* iamcredentials.projects.serviceAccounts.generateIdToken
* @desc Generates an OpenID Connect ID token for a service account.
* @alias iamcredentials.projects.serviceAccounts.generateIdToken
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid.
* @param {().GenerateIdTokenRequest} params.resource Request body data
* @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
*/
generateIdToken(params?: Params$Resource$Projects$Serviceaccounts$Generateidtoken, options?: MethodOptions): GaxiosPromise<Schema$GenerateIdTokenResponse>;
generateIdToken(params: Params$Resource$Projects$Serviceaccounts$Generateidtoken, options: MethodOptions | BodyResponseCallback<Schema$GenerateIdTokenResponse>, callback: BodyResponseCallback<Schema$GenerateIdTokenResponse>): void;
generateIdToken(params: Params$Resource$Projects$Serviceaccounts$Generateidtoken, callback: BodyResponseCallback<Schema$GenerateIdTokenResponse>): void;
generateIdToken(callback: BodyResponseCallback<Schema$GenerateIdTokenResponse>): void;
/**
* iamcredentials.projects.serviceAccounts.signBlob
* @desc Signs a blob using a service account's system-managed private key.
* @alias iamcredentials.projects.serviceAccounts.signBlob
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid.
* @param {().SignBlobRequest} params.resource Request body data
* @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
*/
signBlob(params?: Params$Resource$Projects$Serviceaccounts$Signblob, options?: MethodOptions): GaxiosPromise<Schema$SignBlobResponse>;
signBlob(params: Params$Resource$Projects$Serviceaccounts$Signblob, options: MethodOptions | BodyResponseCallback<Schema$SignBlobResponse>, callback: BodyResponseCallback<Schema$SignBlobResponse>): void;
signBlob(params: Params$Resource$Projects$Serviceaccounts$Signblob, callback: BodyResponseCallback<Schema$SignBlobResponse>): void;
signBlob(callback: BodyResponseCallback<Schema$SignBlobResponse>): void;
/**
* iamcredentials.projects.serviceAccounts.signJwt
* @desc Signs a JWT using a service account's system-managed private key.
* @alias iamcredentials.projects.serviceAccounts.signJwt
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid.
* @param {().SignJwtRequest} params.resource Request body data
* @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
*/
signJwt(params?: Params$Resource$Projects$Serviceaccounts$Signjwt, options?: MethodOptions): GaxiosPromise<Schema$SignJwtResponse>;
signJwt(params: Params$Resource$Projects$Serviceaccounts$Signjwt, options: MethodOptions | BodyResponseCallback<Schema$SignJwtResponse>, callback: BodyResponseCallback<Schema$SignJwtResponse>): void;
signJwt(params: Params$Resource$Projects$Serviceaccounts$Signjwt, callback: BodyResponseCallback<Schema$SignJwtResponse>): void;
signJwt(callback: BodyResponseCallback<Schema$SignJwtResponse>): void;
}
interface Params$Resource$Projects$Serviceaccounts$Generateaccesstoken extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name of the service account for which the credentials are
* requested, in the following format:
* `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-`
* wildcard character is required; replacing it with a project ID is
* invalid.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GenerateAccessTokenRequest;
}
interface Params$Resource$Projects$Serviceaccounts$Generateidentitybindingaccesstoken extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name of the service account for which the credentials are
* requested, in the following format:
* `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-`
* wildcard character is required; replacing it with a project ID is
* invalid.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GenerateIdentityBindingAccessTokenRequest;
}
interface Params$Resource$Projects$Serviceaccounts$Generateidtoken extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name of the service account for which the credentials are
* requested, in the following format:
* `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-`
* wildcard character is required; replacing it with a project ID is
* invalid.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GenerateIdTokenRequest;
}
interface Params$Resource$Projects$Serviceaccounts$Signblob extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name of the service account for which the credentials are
* requested, in the following format:
* `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-`
* wildcard character is required; replacing it with a project ID is
* invalid.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SignBlobRequest;
}
interface Params$Resource$Projects$Serviceaccounts$Signjwt extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name of the service account for which the credentials are
* requested, in the following format:
* `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-`
* wildcard character is required; replacing it with a project ID is
* invalid.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SignJwtRequest;
}
}