@zuplo/runtime 5.2346.0 → 5.2348.0

package/out/types/index.d.ts

@@ -5011,6 +5011,65 @@ export declare interface UpstreamFirebaseUserAuthInboundPolicyOptions {
     expirationOffsetSeconds?: number;
 }
 
+/**
+ * Authenticates with GCP resources or Google services using Workload Identity
+ * Federation allowing secure access to these resources without requiring the
+ * use of a service account private key.
+ *
+ * @title Upstream GCP Federated Auth Inbound
+ * @beta
+ * @enterprise
+ * @param request - The ZuploRequest
+ * @param context - The ZuploContext
+ * @param options - The policy options set in policies.json
+ * @param policyName - The name of the policy as set in policies.json
+ * @returns A Request or a Response
+ */
+export declare class UpstreamGcpFederatedAuthInboundPolicy extends InboundPolicy<UpstreamGcpFederatedAuthInboundPolicyOptions> {
+    private cacheName;
+    private normalizedWorkloadIdentityProvider;
+    constructor(options: UpstreamGcpFederatedAuthInboundPolicyOptions, policyName: string);
+    /**
+     * The handler that is called each time this policy is invoked
+     *
+     * @param request - The incoming Request
+     * @param context - The current context of the Request
+     * @returns A Response or Request object
+     */
+    handler(request: ZuploRequest, context: ZuploContext): Promise<ZuploRequest | Response>;
+}
+
+/**
+ * The options for this policy.
+ */
+export declare interface UpstreamGcpFederatedAuthInboundPolicyOptions {
+    /**
+     * The audience for the minted JWT. This is typically the URL of your service. See the document {@link https://cloud.google.com/endpoints/docs/grpc-service-config/reference/rpc/google.api#google.api.AuthRequirement|AuthRequirement} for details.
+     */
+    audience: string;
+    /**
+     * The Google Service Account email address.
+     */
+    serviceAccountEmail: string;
+    workloadIdentityProvider: string;
+    /**
+     * The lifetime in seconds of the issued token.
+     */
+    tokenLifetime?: number;
+    /**
+     * The number of times to retry fetching the token in the event of a failure.
+     */
+    tokenRetries?: number;
+    /**
+     * The number of seconds less than the token expiration to cache the token.
+     */
+    expirationOffsetSeconds?: number;
+    /**
+     * This is an advanced option that should only be used if you do not want to persist information in ZoneCache.
+     */
+    useMemoryCacheOnly?: boolean;
+}
+
 /**
  * Creates a self-signed JWT token (generated using a Google Service Account
  * JSON) and attaches it to the outgoing request. Useful when calling GCP

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zuplo/runtime",
-  "version": "5.2346.0",
+  "version": "5.2348.0",
   "repository": "https://github.com/zuplo/zuplo",
   "author": "Zuplo, Inc.",
   "exports": {