@zuplo/runtime 5.2493.0 → 5.2495.0

package/out/types/index.d.ts

@@ -164,6 +164,72 @@ declare interface APITokenCredentialConfig {
     headerValuePrefix?: string;
 }
 
+/**
+ * Authorize requests using Aserto.
+ *
+ * @title Aserto Authorization
+ * @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 AsertoAuthZInboundPolicy extends InboundPolicy<AsertoAuthZInboundPolicyOptions> {
+    private cache;
+    private authorizationUrl;
+    static setAuthorizationContext(context: ZuploContext, asertoContext: AsertoContext): void;
+    constructor(options: AsertoAuthZInboundPolicyOptions, 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 AsertoAuthZInboundPolicyOptions {
+    /**
+     * Indicates whether the request should continue if authorization fails. Default is `false` which means unauthorized users will automatically receive a 403 response.
+     */
+    allowUnauthorizedRequests?: boolean;
+    /**
+     * The Aserto Tenant ID.
+     */
+    tenantId: string;
+    /**
+     * The Aserto API key.
+     */
+    authorizerApiKey: string;
+    /**
+     * The Aserto Authorizer API URL.
+     */
+    authorizerApiUrl?: string;
+    /**
+     * The name of the Asserto policy to use for authorization.
+     */
+    authorizerPolicyName?: string;
+    /**
+     * Canonicalized service name (required unless all the overrides below are provided).
+     */
+    serviceName?: string;
+}
+
+declare interface AsertoContext {
+    identity_context: {
+        identity: string;
+        type: "IDENTITY_TYPE_SUB" | "IDENTITY_TYPE_NONE" | "IDENTITY_TYPE_JWT";
+    };
+    policy_context: PolicyContext;
+    policy_instance: PolicyInstance;
+    resource_context: ResourceContext;
+}
+
 /**
  * A list of attributes that will be included in the authorization request.
  */
@@ -3871,6 +3937,16 @@ export declare interface PolicyConfiguration {
     options?: unknown;
 }
 
+declare interface PolicyContext {
+    decisions: string[];
+    path: string;
+}
+
+declare interface PolicyInstance {
+    name: string;
+    instance_label: string;
+}
+
 declare type Primitive = null | undefined | string | number | boolean | symbol | bigint;
 
 /**
@@ -4468,6 +4544,8 @@ declare type ResolveRequestQuery<TQuery extends RequestQueryDefault | undefined>
 
 declare type ResolveUserData<TUserData extends UserDataDefault | undefined> = TUserData extends UserDataDefault ? TUserData : UserDataDefault;
 
+declare type ResourceContext = Record<string, string>;
+
 /**
  * @beta
  */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zuplo/runtime",
   "type": "module",
-  "version": "5.2493.0",
+  "version": "5.2495.0",
   "repository": "https://github.com/zuplo/zuplo",
   "author": "Zuplo, Inc.",
   "exports": {