@zuplo/runtime 5.2292.0 → 5.2293.0

package/out/types/index.d.ts

@@ -604,6 +604,23 @@ declare abstract class BaseKeyValueStore {
     abstract delete(key: string): Promise<void>;
 }
 
+declare class BaseOpenFGAAuthZInboundPolicy extends InboundPolicy<OpenFGAAuthZInboundPolicyOptions> {
+    private client;
+    private authorizer;
+    private cache;
+    static setContextChecks(context: ZuploContext, checks: OpenFGACheck | OpenFGACheck[]): void;
+    constructor(options: OpenFGAAuthZInboundPolicyOptions, 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>;
+    private getAuthorizer;
+}
+
 /**
  * An account object.
  */
@@ -3179,6 +3196,59 @@ declare interface NotFoundOptions {
     routesMatchedByPathOnly: RouteConfiguration[];
 }
 
+/**
+ * Authorize requests using Okta FGA.
+ *
+ * @remarks
+ * This policy will authorize requests using Okta FGA. If the
+ * request is not authorized, a 403 response will be returned.
+ *
+ *
+ * @title Okta FGA Authorization Inbound
+ * @beta
+ * @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 OktaFGAAuthZInboundPolicy extends BaseOpenFGAAuthZInboundPolicy {
+    constructor(options: OktaFGAAuthZInboundPolicyOptions, policyName: string);
+}
+
+/**
+ * The options for this policy.
+ */
+export declare interface OktaFGAAuthZInboundPolicyOptions {
+    /**
+     * The region your store is deployed.
+     */
+    region: "us1" | "eu1" | "au1";
+    /**
+     * The ID of the store.
+     */
+    storeId: string;
+    /**
+     * The ID of the authorization model.
+     */
+    authorizationModelId: string;
+    /**
+     * Indicates whether the request should continue if authorization fails. Default is `false` which means unauthorized users will automatically receive a 403 response.
+     */
+    allowUnauthorizedRequests?: boolean;
+    credentials: {
+        /**
+         * The client ID.
+         */
+        clientId: string;
+        /**
+         * The client secret.
+         */
+        clientSecret: string;
+        [k: string]: unknown;
+    };
+}
+
 /**
  * Authenticate users using Okta issued JWT tokens.
  *
@@ -3729,21 +3799,8 @@ declare namespace OpenAPIV3_1 {
  * @param policyName - The name of the policy as set in policies.json
  * @returns A Request or a Response
  */
-export declare class OpenFGAAuthZInboundPolicy extends InboundPolicy<OpenFGAAuthZInboundPolicyOptions> {
-    private client;
-    private authorizer;
-    private cache;
-    static setContextChecks(context: ZuploContext, checks: OpenFGACheck | OpenFGACheck[]): void;
+export declare class OpenFGAAuthZInboundPolicy extends BaseOpenFGAAuthZInboundPolicy {
     constructor(options: OpenFGAAuthZInboundPolicyOptions, 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>;
-    private getAuthorizer;
 }
 
 /**
@@ -3757,16 +3814,16 @@ export declare interface OpenFGAAuthZInboundPolicyOptions {
     /**
      * The ID of the store.
      */
-    storeId?: string;
+    storeId: string;
     /**
      * The ID of the authorization model.
      */
-    authorizationModelId?: string;
+    authorizationModelId: string;
     /**
      * Indicates whether the request should continue if authorization fails. Default is `false` which means unauthorized users will automatically receive a 403 response.
      */
     allowUnauthorizedRequests?: boolean;
-    credentials?: UnauthenticatedCredentialConfig | APITokenCredentialConfig | HeaderCredentialsConfig | ClientCredentialsConfig;
+    credentials: UnauthenticatedCredentialConfig | APITokenCredentialConfig | HeaderCredentialsConfig | ClientCredentialsConfig;
 }
 
 declare interface OpenFGACheck {

package/package.json

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