@googleapis/sts 15.1.1 → 16.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +406 -0
- package/build/v1.js +228 -0
- package/build/v1.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +802 -0
package/build/v1.d.ts
CHANGED
|
@@ -67,6 +67,8 @@ export declare namespace sts_v1 {
|
|
|
67
67
|
*/
|
|
68
68
|
export class Sts {
|
|
69
69
|
context: APIRequestContext;
|
|
70
|
+
organizations: Resource$Organizations;
|
|
71
|
+
projects: Resource$Projects;
|
|
70
72
|
v1: Resource$V1;
|
|
71
73
|
constructor(options: GlobalOptions, google?: GoogleConfigurable);
|
|
72
74
|
}
|
|
@@ -210,6 +212,77 @@ export declare namespace sts_v1 {
|
|
|
210
212
|
*/
|
|
211
213
|
token_type?: string | null;
|
|
212
214
|
}
|
|
215
|
+
/**
|
|
216
|
+
* A JSON web key set (JWK) See also https://datatracker.ietf.org/doc/html/rfc7517 and https://github.com/spiffe/spiffe/blob/main/standards/JWT-SVID.md#6-representation-in-the-spiffe-bundle
|
|
217
|
+
*/
|
|
218
|
+
export interface Schema$GoogleIdentityStsV1Jwk {
|
|
219
|
+
/**
|
|
220
|
+
* Algorithm intended for use with the key. Currently "RS256".
|
|
221
|
+
*/
|
|
222
|
+
alg?: string | null;
|
|
223
|
+
/**
|
|
224
|
+
* Exponent value for kty="RSA".
|
|
225
|
+
*/
|
|
226
|
+
e?: string | null;
|
|
227
|
+
/**
|
|
228
|
+
* Key ID.
|
|
229
|
+
*/
|
|
230
|
+
kid?: string | null;
|
|
231
|
+
/**
|
|
232
|
+
* Key type. Currently "RSA".
|
|
233
|
+
*/
|
|
234
|
+
kty?: string | null;
|
|
235
|
+
/**
|
|
236
|
+
* Modulus value for kty="RSA".
|
|
237
|
+
*/
|
|
238
|
+
n?: string | null;
|
|
239
|
+
/**
|
|
240
|
+
* Public key use. Currently "sig".
|
|
241
|
+
*/
|
|
242
|
+
use?: string | null;
|
|
243
|
+
}
|
|
244
|
+
/**
|
|
245
|
+
* Response message for GetJwks.
|
|
246
|
+
*/
|
|
247
|
+
export interface Schema$GoogleIdentityStsV1Jwks {
|
|
248
|
+
/**
|
|
249
|
+
* The JWKS for this OP.
|
|
250
|
+
*/
|
|
251
|
+
keys?: Schema$GoogleIdentityStsV1Jwk[];
|
|
252
|
+
}
|
|
253
|
+
/**
|
|
254
|
+
* Response message for GetOpenIdProviderConfig. Message fields are defined in https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse
|
|
255
|
+
*/
|
|
256
|
+
export interface Schema$GoogleIdentityStsV1OpenIdProviderConfig {
|
|
257
|
+
/**
|
|
258
|
+
* URL pointing to an authorization endpoint under this issuer. Note: Currently this endpoint returns a 404.
|
|
259
|
+
*/
|
|
260
|
+
authorization_endpoint?: string | null;
|
|
261
|
+
/**
|
|
262
|
+
* JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID token to encode the claims in a JWT [JWT]. Note: Currently always "["RS256"]".
|
|
263
|
+
*/
|
|
264
|
+
id_token_signing_alg_values_supported?: string[] | null;
|
|
265
|
+
/**
|
|
266
|
+
* URL using the https scheme with no query or fragment components that the OP asserts as its issuer identifier.
|
|
267
|
+
*/
|
|
268
|
+
issuer?: string | null;
|
|
269
|
+
/**
|
|
270
|
+
* URL of the OP's JWK Set [JWK] document, which MUST use the https scheme.
|
|
271
|
+
*/
|
|
272
|
+
jwks_uri?: string | null;
|
|
273
|
+
/**
|
|
274
|
+
* JSON array containing a list of the OAuth 2.0 response_type values that this OP supports. Note: Currently always "["id_token"]".
|
|
275
|
+
*/
|
|
276
|
+
response_types_supported?: string[] | null;
|
|
277
|
+
/**
|
|
278
|
+
* JSON array containing a list of the subject identifier types that this OP supports. Note: Currently always "["public"]".
|
|
279
|
+
*/
|
|
280
|
+
subject_types_supported?: string[] | null;
|
|
281
|
+
/**
|
|
282
|
+
* URL pointing to a token endpoint under this issuer. Note: Currently this endpoint returns a 404.
|
|
283
|
+
*/
|
|
284
|
+
token_endpoint?: string | null;
|
|
285
|
+
}
|
|
213
286
|
/**
|
|
214
287
|
* An `Options` object configures features that the Security Token Service supports, but that are not supported by standard OAuth 2.0 token exchange endpoints, as defined in https://tools.ietf.org/html/rfc8693.
|
|
215
288
|
*/
|
|
@@ -248,6 +321,339 @@ export declare namespace sts_v1 {
|
|
|
248
321
|
*/
|
|
249
322
|
title?: string | null;
|
|
250
323
|
}
|
|
324
|
+
export class Resource$Organizations {
|
|
325
|
+
context: APIRequestContext;
|
|
326
|
+
locations: Resource$Organizations$Locations;
|
|
327
|
+
constructor(context: APIRequestContext);
|
|
328
|
+
}
|
|
329
|
+
export class Resource$Organizations$Locations {
|
|
330
|
+
context: APIRequestContext;
|
|
331
|
+
workloadIdentityPools: Resource$Organizations$Locations$Workloadidentitypools;
|
|
332
|
+
constructor(context: APIRequestContext);
|
|
333
|
+
}
|
|
334
|
+
export class Resource$Organizations$Locations$Workloadidentitypools {
|
|
335
|
+
context: APIRequestContext;
|
|
336
|
+
openid: Resource$Organizations$Locations$Workloadidentitypools$Openid;
|
|
337
|
+
wellKnown: Resource$Organizations$Locations$Workloadidentitypools$WellKnown;
|
|
338
|
+
constructor(context: APIRequestContext);
|
|
339
|
+
}
|
|
340
|
+
export class Resource$Organizations$Locations$Workloadidentitypools$Openid {
|
|
341
|
+
context: APIRequestContext;
|
|
342
|
+
constructor(context: APIRequestContext);
|
|
343
|
+
/**
|
|
344
|
+
* Fetches the signing keys for an agentic or managed workload identity pool and returns them in JWKs format, defined in [RFC 7517](https://tools.ietf.org/html/rfc7517). For now, only agentic system pools are supported. **Preview** This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the [Service Specific Terms](https://cloud.google.com/terms/service-terms#1). Pre-GA features are available "as is" and might have limited support. For more information, see the [launch stage descriptions](https://cloud.google.com/products#product-launch-stages).
|
|
345
|
+
* @example
|
|
346
|
+
* ```js
|
|
347
|
+
* // Before running the sample:
|
|
348
|
+
* // - Enable the API at:
|
|
349
|
+
* // https://console.developers.google.com/apis/api/sts.googleapis.com
|
|
350
|
+
* // - Login into gcloud by running:
|
|
351
|
+
* // ```sh
|
|
352
|
+
* // $ gcloud auth application-default login
|
|
353
|
+
* // ```
|
|
354
|
+
* // - Install the npm module by running:
|
|
355
|
+
* // ```sh
|
|
356
|
+
* // $ npm install googleapis
|
|
357
|
+
* // ```
|
|
358
|
+
*
|
|
359
|
+
* const {google} = require('googleapis');
|
|
360
|
+
* const sts = google.sts('v1');
|
|
361
|
+
*
|
|
362
|
+
* async function main() {
|
|
363
|
+
* const auth = new google.auth.GoogleAuth({
|
|
364
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
365
|
+
* scopes: [],
|
|
366
|
+
* });
|
|
367
|
+
*
|
|
368
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
369
|
+
* const authClient = await auth.getClient();
|
|
370
|
+
* google.options({auth: authClient});
|
|
371
|
+
*
|
|
372
|
+
* // Do the magic
|
|
373
|
+
* const res =
|
|
374
|
+
* await sts.organizations.locations.workloadIdentityPools.openid.getJwks({
|
|
375
|
+
* // Required. The name of the pool whose JWKS needs to be retrieved. Format: 'organizations/{ORGANIZATION_NUMBER\}/locations/global/workloadIdentityPools/{POOL_ID\}' 'projects/{PROJECT_NUMBER\}/locations/global/workloadIdentityPools/{POOL_ID\}' Example(s): 'organizations/1234/locations/global/workloadIdentityPools/agents.global.org-1234.system.id.goog' 'projects/12345678/locations/global/workloadIdentityPools/agents.global.proj-12345678.system.id.goog'
|
|
376
|
+
* name: 'organizations/my-organization/locations/my-location/workloadIdentityPools/my-workloadIdentityPool',
|
|
377
|
+
* });
|
|
378
|
+
* console.log(res.data);
|
|
379
|
+
*
|
|
380
|
+
* // Example response
|
|
381
|
+
* // {
|
|
382
|
+
* // "keys": []
|
|
383
|
+
* // }
|
|
384
|
+
* }
|
|
385
|
+
*
|
|
386
|
+
* main().catch(e => {
|
|
387
|
+
* console.error(e);
|
|
388
|
+
* throw e;
|
|
389
|
+
* });
|
|
390
|
+
*
|
|
391
|
+
* ```
|
|
392
|
+
*
|
|
393
|
+
* @param params - Parameters for request
|
|
394
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
395
|
+
* @param callback - Optional callback that handles the response.
|
|
396
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
397
|
+
*/
|
|
398
|
+
getJwks(params: Params$Resource$Organizations$Locations$Workloadidentitypools$Openid$Getjwks, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
399
|
+
getJwks(params?: Params$Resource$Organizations$Locations$Workloadidentitypools$Openid$Getjwks, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleIdentityStsV1Jwks>>;
|
|
400
|
+
getJwks(params: Params$Resource$Organizations$Locations$Workloadidentitypools$Openid$Getjwks, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
401
|
+
getJwks(params: Params$Resource$Organizations$Locations$Workloadidentitypools$Openid$Getjwks, options: MethodOptions | BodyResponseCallback<Schema$GoogleIdentityStsV1Jwks>, callback: BodyResponseCallback<Schema$GoogleIdentityStsV1Jwks>): void;
|
|
402
|
+
getJwks(params: Params$Resource$Organizations$Locations$Workloadidentitypools$Openid$Getjwks, callback: BodyResponseCallback<Schema$GoogleIdentityStsV1Jwks>): void;
|
|
403
|
+
getJwks(callback: BodyResponseCallback<Schema$GoogleIdentityStsV1Jwks>): void;
|
|
404
|
+
}
|
|
405
|
+
export interface Params$Resource$Organizations$Locations$Workloadidentitypools$Openid$Getjwks extends StandardParameters {
|
|
406
|
+
/**
|
|
407
|
+
* Required. The name of the pool whose JWKS needs to be retrieved. Format: 'organizations/{ORGANIZATION_NUMBER\}/locations/global/workloadIdentityPools/{POOL_ID\}' 'projects/{PROJECT_NUMBER\}/locations/global/workloadIdentityPools/{POOL_ID\}' Example(s): 'organizations/1234/locations/global/workloadIdentityPools/agents.global.org-1234.system.id.goog' 'projects/12345678/locations/global/workloadIdentityPools/agents.global.proj-12345678.system.id.goog'
|
|
408
|
+
*/
|
|
409
|
+
name?: string;
|
|
410
|
+
}
|
|
411
|
+
export class Resource$Organizations$Locations$Workloadidentitypools$WellKnown {
|
|
412
|
+
context: APIRequestContext;
|
|
413
|
+
constructor(context: APIRequestContext);
|
|
414
|
+
/**
|
|
415
|
+
* Gets the OIDC provider configuration for an agentic or managed workload identity pool following [the OIDC 1.0 discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). For now, only agentic system pools are supported. **Preview** This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the [Service Specific Terms](https://cloud.google.com/terms/service-terms#1). Pre-GA features are available "as is" and might have limited support. For more information, see the [launch stage descriptions](https://cloud.google.com/products#product-launch-stages).
|
|
416
|
+
* @example
|
|
417
|
+
* ```js
|
|
418
|
+
* // Before running the sample:
|
|
419
|
+
* // - Enable the API at:
|
|
420
|
+
* // https://console.developers.google.com/apis/api/sts.googleapis.com
|
|
421
|
+
* // - Login into gcloud by running:
|
|
422
|
+
* // ```sh
|
|
423
|
+
* // $ gcloud auth application-default login
|
|
424
|
+
* // ```
|
|
425
|
+
* // - Install the npm module by running:
|
|
426
|
+
* // ```sh
|
|
427
|
+
* // $ npm install googleapis
|
|
428
|
+
* // ```
|
|
429
|
+
*
|
|
430
|
+
* const {google} = require('googleapis');
|
|
431
|
+
* const sts = google.sts('v1');
|
|
432
|
+
*
|
|
433
|
+
* async function main() {
|
|
434
|
+
* const auth = new google.auth.GoogleAuth({
|
|
435
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
436
|
+
* scopes: [],
|
|
437
|
+
* });
|
|
438
|
+
*
|
|
439
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
440
|
+
* const authClient = await auth.getClient();
|
|
441
|
+
* google.options({auth: authClient});
|
|
442
|
+
*
|
|
443
|
+
* // Do the magic
|
|
444
|
+
* const res =
|
|
445
|
+
* (await sts.organizations.locations.workloadIdentityPools.well) -
|
|
446
|
+
* known.getOpenid -
|
|
447
|
+
* configuration({
|
|
448
|
+
* // Required. The name of the pool whose OpenID provider configuration to retrieve. Format: 'organizations/{ORGANIZATION_NUMBER\}/locations/global/workloadIdentityPools/{POOL_ID\}' 'projects/{PROJECT_NUMBER\}/locations/global/workloadIdentityPools/{POOL_ID\}' Example: 'organizations/1234/locations/global/workloadIdentityPools/agents.global.org-1234.system.id.goog' 'projects/12345678/locations/global/workloadIdentityPools/agents.global.proj-12345678.system.id.goog'
|
|
449
|
+
* name: 'organizations/my-organization/locations/my-location/workloadIdentityPools/my-workloadIdentityPool',
|
|
450
|
+
* });
|
|
451
|
+
* console.log(res.data);
|
|
452
|
+
*
|
|
453
|
+
* // Example response
|
|
454
|
+
* // {
|
|
455
|
+
* // "authorization_endpoint": "my_authorization_endpoint",
|
|
456
|
+
* // "id_token_signing_alg_values_supported": [],
|
|
457
|
+
* // "issuer": "my_issuer",
|
|
458
|
+
* // "jwks_uri": "my_jwks_uri",
|
|
459
|
+
* // "response_types_supported": [],
|
|
460
|
+
* // "subject_types_supported": [],
|
|
461
|
+
* // "token_endpoint": "my_token_endpoint"
|
|
462
|
+
* // }
|
|
463
|
+
* }
|
|
464
|
+
*
|
|
465
|
+
* main().catch(e => {
|
|
466
|
+
* console.error(e);
|
|
467
|
+
* throw e;
|
|
468
|
+
* });
|
|
469
|
+
*
|
|
470
|
+
* ```
|
|
471
|
+
*
|
|
472
|
+
* @param params - Parameters for request
|
|
473
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
474
|
+
* @param callback - Optional callback that handles the response.
|
|
475
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
476
|
+
*/
|
|
477
|
+
getOpenidConfiguration(params: Params$Resource$Organizations$Locations$Workloadidentitypools$WellKnown$Getopenidconfiguration, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
478
|
+
getOpenidConfiguration(params?: Params$Resource$Organizations$Locations$Workloadidentitypools$WellKnown$Getopenidconfiguration, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleIdentityStsV1OpenIdProviderConfig>>;
|
|
479
|
+
getOpenidConfiguration(params: Params$Resource$Organizations$Locations$Workloadidentitypools$WellKnown$Getopenidconfiguration, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
480
|
+
getOpenidConfiguration(params: Params$Resource$Organizations$Locations$Workloadidentitypools$WellKnown$Getopenidconfiguration, options: MethodOptions | BodyResponseCallback<Schema$GoogleIdentityStsV1OpenIdProviderConfig>, callback: BodyResponseCallback<Schema$GoogleIdentityStsV1OpenIdProviderConfig>): void;
|
|
481
|
+
getOpenidConfiguration(params: Params$Resource$Organizations$Locations$Workloadidentitypools$WellKnown$Getopenidconfiguration, callback: BodyResponseCallback<Schema$GoogleIdentityStsV1OpenIdProviderConfig>): void;
|
|
482
|
+
getOpenidConfiguration(callback: BodyResponseCallback<Schema$GoogleIdentityStsV1OpenIdProviderConfig>): void;
|
|
483
|
+
}
|
|
484
|
+
export interface Params$Resource$Organizations$Locations$Workloadidentitypools$WellKnown$Getopenidconfiguration extends StandardParameters {
|
|
485
|
+
/**
|
|
486
|
+
* Required. The name of the pool whose OpenID provider configuration to retrieve. Format: 'organizations/{ORGANIZATION_NUMBER\}/locations/global/workloadIdentityPools/{POOL_ID\}' 'projects/{PROJECT_NUMBER\}/locations/global/workloadIdentityPools/{POOL_ID\}' Example: 'organizations/1234/locations/global/workloadIdentityPools/agents.global.org-1234.system.id.goog' 'projects/12345678/locations/global/workloadIdentityPools/agents.global.proj-12345678.system.id.goog'
|
|
487
|
+
*/
|
|
488
|
+
name?: string;
|
|
489
|
+
}
|
|
490
|
+
export class Resource$Projects {
|
|
491
|
+
context: APIRequestContext;
|
|
492
|
+
locations: Resource$Projects$Locations;
|
|
493
|
+
constructor(context: APIRequestContext);
|
|
494
|
+
}
|
|
495
|
+
export class Resource$Projects$Locations {
|
|
496
|
+
context: APIRequestContext;
|
|
497
|
+
workloadIdentityPools: Resource$Projects$Locations$Workloadidentitypools;
|
|
498
|
+
constructor(context: APIRequestContext);
|
|
499
|
+
}
|
|
500
|
+
export class Resource$Projects$Locations$Workloadidentitypools {
|
|
501
|
+
context: APIRequestContext;
|
|
502
|
+
openid: Resource$Projects$Locations$Workloadidentitypools$Openid;
|
|
503
|
+
wellKnown: Resource$Projects$Locations$Workloadidentitypools$WellKnown;
|
|
504
|
+
constructor(context: APIRequestContext);
|
|
505
|
+
}
|
|
506
|
+
export class Resource$Projects$Locations$Workloadidentitypools$Openid {
|
|
507
|
+
context: APIRequestContext;
|
|
508
|
+
constructor(context: APIRequestContext);
|
|
509
|
+
/**
|
|
510
|
+
* Fetches the signing keys for an agentic or managed workload identity pool and returns them in JWKs format, defined in [RFC 7517](https://tools.ietf.org/html/rfc7517). For now, only agentic system pools are supported. **Preview** This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the [Service Specific Terms](https://cloud.google.com/terms/service-terms#1). Pre-GA features are available "as is" and might have limited support. For more information, see the [launch stage descriptions](https://cloud.google.com/products#product-launch-stages).
|
|
511
|
+
* @example
|
|
512
|
+
* ```js
|
|
513
|
+
* // Before running the sample:
|
|
514
|
+
* // - Enable the API at:
|
|
515
|
+
* // https://console.developers.google.com/apis/api/sts.googleapis.com
|
|
516
|
+
* // - Login into gcloud by running:
|
|
517
|
+
* // ```sh
|
|
518
|
+
* // $ gcloud auth application-default login
|
|
519
|
+
* // ```
|
|
520
|
+
* // - Install the npm module by running:
|
|
521
|
+
* // ```sh
|
|
522
|
+
* // $ npm install googleapis
|
|
523
|
+
* // ```
|
|
524
|
+
*
|
|
525
|
+
* const {google} = require('googleapis');
|
|
526
|
+
* const sts = google.sts('v1');
|
|
527
|
+
*
|
|
528
|
+
* async function main() {
|
|
529
|
+
* const auth = new google.auth.GoogleAuth({
|
|
530
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
531
|
+
* scopes: [],
|
|
532
|
+
* });
|
|
533
|
+
*
|
|
534
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
535
|
+
* const authClient = await auth.getClient();
|
|
536
|
+
* google.options({auth: authClient});
|
|
537
|
+
*
|
|
538
|
+
* // Do the magic
|
|
539
|
+
* const res = await sts.projects.locations.workloadIdentityPools.openid.getJwks(
|
|
540
|
+
* {
|
|
541
|
+
* // Required. The name of the pool whose JWKS needs to be retrieved. Format: 'organizations/{ORGANIZATION_NUMBER\}/locations/global/workloadIdentityPools/{POOL_ID\}' 'projects/{PROJECT_NUMBER\}/locations/global/workloadIdentityPools/{POOL_ID\}' Example(s): 'organizations/1234/locations/global/workloadIdentityPools/agents.global.org-1234.system.id.goog' 'projects/12345678/locations/global/workloadIdentityPools/agents.global.proj-12345678.system.id.goog'
|
|
542
|
+
* name: 'projects/my-project/locations/my-location/workloadIdentityPools/my-workloadIdentityPool',
|
|
543
|
+
* },
|
|
544
|
+
* );
|
|
545
|
+
* console.log(res.data);
|
|
546
|
+
*
|
|
547
|
+
* // Example response
|
|
548
|
+
* // {
|
|
549
|
+
* // "keys": []
|
|
550
|
+
* // }
|
|
551
|
+
* }
|
|
552
|
+
*
|
|
553
|
+
* main().catch(e => {
|
|
554
|
+
* console.error(e);
|
|
555
|
+
* throw e;
|
|
556
|
+
* });
|
|
557
|
+
*
|
|
558
|
+
* ```
|
|
559
|
+
*
|
|
560
|
+
* @param params - Parameters for request
|
|
561
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
562
|
+
* @param callback - Optional callback that handles the response.
|
|
563
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
564
|
+
*/
|
|
565
|
+
getJwks(params: Params$Resource$Projects$Locations$Workloadidentitypools$Openid$Getjwks, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
566
|
+
getJwks(params?: Params$Resource$Projects$Locations$Workloadidentitypools$Openid$Getjwks, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleIdentityStsV1Jwks>>;
|
|
567
|
+
getJwks(params: Params$Resource$Projects$Locations$Workloadidentitypools$Openid$Getjwks, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
568
|
+
getJwks(params: Params$Resource$Projects$Locations$Workloadidentitypools$Openid$Getjwks, options: MethodOptions | BodyResponseCallback<Schema$GoogleIdentityStsV1Jwks>, callback: BodyResponseCallback<Schema$GoogleIdentityStsV1Jwks>): void;
|
|
569
|
+
getJwks(params: Params$Resource$Projects$Locations$Workloadidentitypools$Openid$Getjwks, callback: BodyResponseCallback<Schema$GoogleIdentityStsV1Jwks>): void;
|
|
570
|
+
getJwks(callback: BodyResponseCallback<Schema$GoogleIdentityStsV1Jwks>): void;
|
|
571
|
+
}
|
|
572
|
+
export interface Params$Resource$Projects$Locations$Workloadidentitypools$Openid$Getjwks extends StandardParameters {
|
|
573
|
+
/**
|
|
574
|
+
* Required. The name of the pool whose JWKS needs to be retrieved. Format: 'organizations/{ORGANIZATION_NUMBER\}/locations/global/workloadIdentityPools/{POOL_ID\}' 'projects/{PROJECT_NUMBER\}/locations/global/workloadIdentityPools/{POOL_ID\}' Example(s): 'organizations/1234/locations/global/workloadIdentityPools/agents.global.org-1234.system.id.goog' 'projects/12345678/locations/global/workloadIdentityPools/agents.global.proj-12345678.system.id.goog'
|
|
575
|
+
*/
|
|
576
|
+
name?: string;
|
|
577
|
+
}
|
|
578
|
+
export class Resource$Projects$Locations$Workloadidentitypools$WellKnown {
|
|
579
|
+
context: APIRequestContext;
|
|
580
|
+
constructor(context: APIRequestContext);
|
|
581
|
+
/**
|
|
582
|
+
* Gets the OIDC provider configuration for an agentic or managed workload identity pool following [the OIDC 1.0 discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). For now, only agentic system pools are supported. **Preview** This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the [Service Specific Terms](https://cloud.google.com/terms/service-terms#1). Pre-GA features are available "as is" and might have limited support. For more information, see the [launch stage descriptions](https://cloud.google.com/products#product-launch-stages).
|
|
583
|
+
* @example
|
|
584
|
+
* ```js
|
|
585
|
+
* // Before running the sample:
|
|
586
|
+
* // - Enable the API at:
|
|
587
|
+
* // https://console.developers.google.com/apis/api/sts.googleapis.com
|
|
588
|
+
* // - Login into gcloud by running:
|
|
589
|
+
* // ```sh
|
|
590
|
+
* // $ gcloud auth application-default login
|
|
591
|
+
* // ```
|
|
592
|
+
* // - Install the npm module by running:
|
|
593
|
+
* // ```sh
|
|
594
|
+
* // $ npm install googleapis
|
|
595
|
+
* // ```
|
|
596
|
+
*
|
|
597
|
+
* const {google} = require('googleapis');
|
|
598
|
+
* const sts = google.sts('v1');
|
|
599
|
+
*
|
|
600
|
+
* async function main() {
|
|
601
|
+
* const auth = new google.auth.GoogleAuth({
|
|
602
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
603
|
+
* scopes: [],
|
|
604
|
+
* });
|
|
605
|
+
*
|
|
606
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
607
|
+
* const authClient = await auth.getClient();
|
|
608
|
+
* google.options({auth: authClient});
|
|
609
|
+
*
|
|
610
|
+
* // Do the magic
|
|
611
|
+
* const res =
|
|
612
|
+
* (await sts.projects.locations.workloadIdentityPools.well) -
|
|
613
|
+
* known.getOpenid -
|
|
614
|
+
* configuration({
|
|
615
|
+
* // Required. The name of the pool whose OpenID provider configuration to retrieve. Format: 'organizations/{ORGANIZATION_NUMBER\}/locations/global/workloadIdentityPools/{POOL_ID\}' 'projects/{PROJECT_NUMBER\}/locations/global/workloadIdentityPools/{POOL_ID\}' Example: 'organizations/1234/locations/global/workloadIdentityPools/agents.global.org-1234.system.id.goog' 'projects/12345678/locations/global/workloadIdentityPools/agents.global.proj-12345678.system.id.goog'
|
|
616
|
+
* name: 'projects/my-project/locations/my-location/workloadIdentityPools/my-workloadIdentityPool',
|
|
617
|
+
* });
|
|
618
|
+
* console.log(res.data);
|
|
619
|
+
*
|
|
620
|
+
* // Example response
|
|
621
|
+
* // {
|
|
622
|
+
* // "authorization_endpoint": "my_authorization_endpoint",
|
|
623
|
+
* // "id_token_signing_alg_values_supported": [],
|
|
624
|
+
* // "issuer": "my_issuer",
|
|
625
|
+
* // "jwks_uri": "my_jwks_uri",
|
|
626
|
+
* // "response_types_supported": [],
|
|
627
|
+
* // "subject_types_supported": [],
|
|
628
|
+
* // "token_endpoint": "my_token_endpoint"
|
|
629
|
+
* // }
|
|
630
|
+
* }
|
|
631
|
+
*
|
|
632
|
+
* main().catch(e => {
|
|
633
|
+
* console.error(e);
|
|
634
|
+
* throw e;
|
|
635
|
+
* });
|
|
636
|
+
*
|
|
637
|
+
* ```
|
|
638
|
+
*
|
|
639
|
+
* @param params - Parameters for request
|
|
640
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
641
|
+
* @param callback - Optional callback that handles the response.
|
|
642
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
643
|
+
*/
|
|
644
|
+
getOpenidConfiguration(params: Params$Resource$Projects$Locations$Workloadidentitypools$WellKnown$Getopenidconfiguration, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
645
|
+
getOpenidConfiguration(params?: Params$Resource$Projects$Locations$Workloadidentitypools$WellKnown$Getopenidconfiguration, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleIdentityStsV1OpenIdProviderConfig>>;
|
|
646
|
+
getOpenidConfiguration(params: Params$Resource$Projects$Locations$Workloadidentitypools$WellKnown$Getopenidconfiguration, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
647
|
+
getOpenidConfiguration(params: Params$Resource$Projects$Locations$Workloadidentitypools$WellKnown$Getopenidconfiguration, options: MethodOptions | BodyResponseCallback<Schema$GoogleIdentityStsV1OpenIdProviderConfig>, callback: BodyResponseCallback<Schema$GoogleIdentityStsV1OpenIdProviderConfig>): void;
|
|
648
|
+
getOpenidConfiguration(params: Params$Resource$Projects$Locations$Workloadidentitypools$WellKnown$Getopenidconfiguration, callback: BodyResponseCallback<Schema$GoogleIdentityStsV1OpenIdProviderConfig>): void;
|
|
649
|
+
getOpenidConfiguration(callback: BodyResponseCallback<Schema$GoogleIdentityStsV1OpenIdProviderConfig>): void;
|
|
650
|
+
}
|
|
651
|
+
export interface Params$Resource$Projects$Locations$Workloadidentitypools$WellKnown$Getopenidconfiguration extends StandardParameters {
|
|
652
|
+
/**
|
|
653
|
+
* Required. The name of the pool whose OpenID provider configuration to retrieve. Format: 'organizations/{ORGANIZATION_NUMBER\}/locations/global/workloadIdentityPools/{POOL_ID\}' 'projects/{PROJECT_NUMBER\}/locations/global/workloadIdentityPools/{POOL_ID\}' Example: 'organizations/1234/locations/global/workloadIdentityPools/agents.global.org-1234.system.id.goog' 'projects/12345678/locations/global/workloadIdentityPools/agents.global.proj-12345678.system.id.goog'
|
|
654
|
+
*/
|
|
655
|
+
name?: string;
|
|
656
|
+
}
|
|
251
657
|
export class Resource$V1 {
|
|
252
658
|
context: APIRequestContext;
|
|
253
659
|
constructor(context: APIRequestContext);
|
package/build/v1.js
CHANGED
|
@@ -34,16 +34,244 @@ var sts_v1;
|
|
|
34
34
|
*/
|
|
35
35
|
class Sts {
|
|
36
36
|
context;
|
|
37
|
+
organizations;
|
|
38
|
+
projects;
|
|
37
39
|
v1;
|
|
38
40
|
constructor(options, google) {
|
|
39
41
|
this.context = {
|
|
40
42
|
_options: options || {},
|
|
41
43
|
google,
|
|
42
44
|
};
|
|
45
|
+
this.organizations = new Resource$Organizations(this.context);
|
|
46
|
+
this.projects = new Resource$Projects(this.context);
|
|
43
47
|
this.v1 = new Resource$V1(this.context);
|
|
44
48
|
}
|
|
45
49
|
}
|
|
46
50
|
sts_v1.Sts = Sts;
|
|
51
|
+
class Resource$Organizations {
|
|
52
|
+
context;
|
|
53
|
+
locations;
|
|
54
|
+
constructor(context) {
|
|
55
|
+
this.context = context;
|
|
56
|
+
this.locations = new Resource$Organizations$Locations(this.context);
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
sts_v1.Resource$Organizations = Resource$Organizations;
|
|
60
|
+
class Resource$Organizations$Locations {
|
|
61
|
+
context;
|
|
62
|
+
workloadIdentityPools;
|
|
63
|
+
constructor(context) {
|
|
64
|
+
this.context = context;
|
|
65
|
+
this.workloadIdentityPools =
|
|
66
|
+
new Resource$Organizations$Locations$Workloadidentitypools(this.context);
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
sts_v1.Resource$Organizations$Locations = Resource$Organizations$Locations;
|
|
70
|
+
class Resource$Organizations$Locations$Workloadidentitypools {
|
|
71
|
+
context;
|
|
72
|
+
openid;
|
|
73
|
+
wellKnown;
|
|
74
|
+
constructor(context) {
|
|
75
|
+
this.context = context;
|
|
76
|
+
this.openid =
|
|
77
|
+
new Resource$Organizations$Locations$Workloadidentitypools$Openid(this.context);
|
|
78
|
+
this.wellKnown =
|
|
79
|
+
new Resource$Organizations$Locations$Workloadidentitypools$WellKnown(this.context);
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
sts_v1.Resource$Organizations$Locations$Workloadidentitypools = Resource$Organizations$Locations$Workloadidentitypools;
|
|
83
|
+
class Resource$Organizations$Locations$Workloadidentitypools$Openid {
|
|
84
|
+
context;
|
|
85
|
+
constructor(context) {
|
|
86
|
+
this.context = context;
|
|
87
|
+
}
|
|
88
|
+
getJwks(paramsOrCallback, optionsOrCallback, callback) {
|
|
89
|
+
let params = (paramsOrCallback ||
|
|
90
|
+
{});
|
|
91
|
+
let options = (optionsOrCallback || {});
|
|
92
|
+
if (typeof paramsOrCallback === 'function') {
|
|
93
|
+
callback = paramsOrCallback;
|
|
94
|
+
params =
|
|
95
|
+
{};
|
|
96
|
+
options = {};
|
|
97
|
+
}
|
|
98
|
+
if (typeof optionsOrCallback === 'function') {
|
|
99
|
+
callback = optionsOrCallback;
|
|
100
|
+
options = {};
|
|
101
|
+
}
|
|
102
|
+
const rootUrl = options.rootUrl || 'https://sts.googleapis.com/';
|
|
103
|
+
const parameters = {
|
|
104
|
+
options: Object.assign({
|
|
105
|
+
url: (rootUrl + '/v1/{+name}/openid/jwks').replace(/([^:]\/)\/+/g, '$1'),
|
|
106
|
+
method: 'GET',
|
|
107
|
+
apiVersion: '',
|
|
108
|
+
}, options),
|
|
109
|
+
params,
|
|
110
|
+
requiredParams: ['name'],
|
|
111
|
+
pathParams: ['name'],
|
|
112
|
+
context: this.context,
|
|
113
|
+
};
|
|
114
|
+
if (callback) {
|
|
115
|
+
(0, googleapis_common_1.createAPIRequest)(parameters, callback);
|
|
116
|
+
}
|
|
117
|
+
else {
|
|
118
|
+
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
sts_v1.Resource$Organizations$Locations$Workloadidentitypools$Openid = Resource$Organizations$Locations$Workloadidentitypools$Openid;
|
|
123
|
+
class Resource$Organizations$Locations$Workloadidentitypools$WellKnown {
|
|
124
|
+
context;
|
|
125
|
+
constructor(context) {
|
|
126
|
+
this.context = context;
|
|
127
|
+
}
|
|
128
|
+
getOpenidConfiguration(paramsOrCallback, optionsOrCallback, callback) {
|
|
129
|
+
let params = (paramsOrCallback ||
|
|
130
|
+
{});
|
|
131
|
+
let options = (optionsOrCallback || {});
|
|
132
|
+
if (typeof paramsOrCallback === 'function') {
|
|
133
|
+
callback = paramsOrCallback;
|
|
134
|
+
params =
|
|
135
|
+
{};
|
|
136
|
+
options = {};
|
|
137
|
+
}
|
|
138
|
+
if (typeof optionsOrCallback === 'function') {
|
|
139
|
+
callback = optionsOrCallback;
|
|
140
|
+
options = {};
|
|
141
|
+
}
|
|
142
|
+
const rootUrl = options.rootUrl || 'https://sts.googleapis.com/';
|
|
143
|
+
const parameters = {
|
|
144
|
+
options: Object.assign({
|
|
145
|
+
url: (rootUrl + '/v1/{+name}/.well-known/openid-configuration').replace(/([^:]\/)\/+/g, '$1'),
|
|
146
|
+
method: 'GET',
|
|
147
|
+
apiVersion: '',
|
|
148
|
+
}, options),
|
|
149
|
+
params,
|
|
150
|
+
requiredParams: ['name'],
|
|
151
|
+
pathParams: ['name'],
|
|
152
|
+
context: this.context,
|
|
153
|
+
};
|
|
154
|
+
if (callback) {
|
|
155
|
+
(0, googleapis_common_1.createAPIRequest)(parameters, callback);
|
|
156
|
+
}
|
|
157
|
+
else {
|
|
158
|
+
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
}
|
|
162
|
+
sts_v1.Resource$Organizations$Locations$Workloadidentitypools$WellKnown = Resource$Organizations$Locations$Workloadidentitypools$WellKnown;
|
|
163
|
+
class Resource$Projects {
|
|
164
|
+
context;
|
|
165
|
+
locations;
|
|
166
|
+
constructor(context) {
|
|
167
|
+
this.context = context;
|
|
168
|
+
this.locations = new Resource$Projects$Locations(this.context);
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
sts_v1.Resource$Projects = Resource$Projects;
|
|
172
|
+
class Resource$Projects$Locations {
|
|
173
|
+
context;
|
|
174
|
+
workloadIdentityPools;
|
|
175
|
+
constructor(context) {
|
|
176
|
+
this.context = context;
|
|
177
|
+
this.workloadIdentityPools =
|
|
178
|
+
new Resource$Projects$Locations$Workloadidentitypools(this.context);
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
sts_v1.Resource$Projects$Locations = Resource$Projects$Locations;
|
|
182
|
+
class Resource$Projects$Locations$Workloadidentitypools {
|
|
183
|
+
context;
|
|
184
|
+
openid;
|
|
185
|
+
wellKnown;
|
|
186
|
+
constructor(context) {
|
|
187
|
+
this.context = context;
|
|
188
|
+
this.openid =
|
|
189
|
+
new Resource$Projects$Locations$Workloadidentitypools$Openid(this.context);
|
|
190
|
+
this.wellKnown =
|
|
191
|
+
new Resource$Projects$Locations$Workloadidentitypools$WellKnown(this.context);
|
|
192
|
+
}
|
|
193
|
+
}
|
|
194
|
+
sts_v1.Resource$Projects$Locations$Workloadidentitypools = Resource$Projects$Locations$Workloadidentitypools;
|
|
195
|
+
class Resource$Projects$Locations$Workloadidentitypools$Openid {
|
|
196
|
+
context;
|
|
197
|
+
constructor(context) {
|
|
198
|
+
this.context = context;
|
|
199
|
+
}
|
|
200
|
+
getJwks(paramsOrCallback, optionsOrCallback, callback) {
|
|
201
|
+
let params = (paramsOrCallback ||
|
|
202
|
+
{});
|
|
203
|
+
let options = (optionsOrCallback || {});
|
|
204
|
+
if (typeof paramsOrCallback === 'function') {
|
|
205
|
+
callback = paramsOrCallback;
|
|
206
|
+
params =
|
|
207
|
+
{};
|
|
208
|
+
options = {};
|
|
209
|
+
}
|
|
210
|
+
if (typeof optionsOrCallback === 'function') {
|
|
211
|
+
callback = optionsOrCallback;
|
|
212
|
+
options = {};
|
|
213
|
+
}
|
|
214
|
+
const rootUrl = options.rootUrl || 'https://sts.googleapis.com/';
|
|
215
|
+
const parameters = {
|
|
216
|
+
options: Object.assign({
|
|
217
|
+
url: (rootUrl + '/v1/{+name}/openid/jwks').replace(/([^:]\/)\/+/g, '$1'),
|
|
218
|
+
method: 'GET',
|
|
219
|
+
apiVersion: '',
|
|
220
|
+
}, options),
|
|
221
|
+
params,
|
|
222
|
+
requiredParams: ['name'],
|
|
223
|
+
pathParams: ['name'],
|
|
224
|
+
context: this.context,
|
|
225
|
+
};
|
|
226
|
+
if (callback) {
|
|
227
|
+
(0, googleapis_common_1.createAPIRequest)(parameters, callback);
|
|
228
|
+
}
|
|
229
|
+
else {
|
|
230
|
+
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
231
|
+
}
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
sts_v1.Resource$Projects$Locations$Workloadidentitypools$Openid = Resource$Projects$Locations$Workloadidentitypools$Openid;
|
|
235
|
+
class Resource$Projects$Locations$Workloadidentitypools$WellKnown {
|
|
236
|
+
context;
|
|
237
|
+
constructor(context) {
|
|
238
|
+
this.context = context;
|
|
239
|
+
}
|
|
240
|
+
getOpenidConfiguration(paramsOrCallback, optionsOrCallback, callback) {
|
|
241
|
+
let params = (paramsOrCallback ||
|
|
242
|
+
{});
|
|
243
|
+
let options = (optionsOrCallback || {});
|
|
244
|
+
if (typeof paramsOrCallback === 'function') {
|
|
245
|
+
callback = paramsOrCallback;
|
|
246
|
+
params =
|
|
247
|
+
{};
|
|
248
|
+
options = {};
|
|
249
|
+
}
|
|
250
|
+
if (typeof optionsOrCallback === 'function') {
|
|
251
|
+
callback = optionsOrCallback;
|
|
252
|
+
options = {};
|
|
253
|
+
}
|
|
254
|
+
const rootUrl = options.rootUrl || 'https://sts.googleapis.com/';
|
|
255
|
+
const parameters = {
|
|
256
|
+
options: Object.assign({
|
|
257
|
+
url: (rootUrl + '/v1/{+name}/.well-known/openid-configuration').replace(/([^:]\/)\/+/g, '$1'),
|
|
258
|
+
method: 'GET',
|
|
259
|
+
apiVersion: '',
|
|
260
|
+
}, options),
|
|
261
|
+
params,
|
|
262
|
+
requiredParams: ['name'],
|
|
263
|
+
pathParams: ['name'],
|
|
264
|
+
context: this.context,
|
|
265
|
+
};
|
|
266
|
+
if (callback) {
|
|
267
|
+
(0, googleapis_common_1.createAPIRequest)(parameters, callback);
|
|
268
|
+
}
|
|
269
|
+
else {
|
|
270
|
+
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
271
|
+
}
|
|
272
|
+
}
|
|
273
|
+
}
|
|
274
|
+
sts_v1.Resource$Projects$Locations$Workloadidentitypools$WellKnown = Resource$Projects$Locations$Workloadidentitypools$WellKnown;
|
|
47
275
|
class Resource$V1 {
|
|
48
276
|
context;
|
|
49
277
|
constructor(context) {
|