@fenixalliance/abs-api-client 1.0.16 → 1.1.0

package/schemas/identityService/schema.s.ts

@@ -5,135 +5,47 @@
 
 
 export interface paths {
-  "/api/v2/Applications/{appID}": {
-    get: {
-      parameters: {
-        query?: {
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-        path: {
-          appID: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: never;
-        };
-      };
-    };
+  "/api/v2/Applications/{appId}": {
+    /**
+     * Get application by ID
+     * @description Retrieves an application by its unique identifier.
+     */
+    get: operations["GetApplication"];
   };
-  "/api/v2/Applications/{appID}/RequiredPermissions": {
-    get: {
-      parameters: {
-        query?: {
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-        path: {
-          appID: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: never;
-        };
-      };
-    };
+  "/api/v2/Applications/{appId}/RequiredPermissions": {
+    /**
+     * Get required permissions for an application
+     * @description Retrieves the list of permissions required by the specified application.
+     */
+    get: operations["GetRequiredPermissions"];
   };
-  "/api/v2/Applications/{appID}/GrantedPermissions": {
-    get: {
-      parameters: {
-        query?: {
-          tenantID?: string;
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-        path: {
-          appID: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: never;
-        };
-      };
-    };
+  "/api/v2/Applications/{appId}/GrantedPermissions": {
+    /**
+     * Get granted tenant permissions for an application
+     * @description Retrieves the list of permissions granted to the specified application within a tenant context.
+     */
+    get: operations["GetGrantedTenantPermissions"];
   };
-  "/api/v2/Applications/{appID}/GrantedRoles": {
-    get: {
-      parameters: {
-        query?: {
-          tenantID?: string;
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-        path: {
-          appID: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: never;
-        };
-      };
-    };
+  "/api/v2/Applications/{appId}/GrantedRoles": {
+    /**
+     * Get granted tenant roles for an application
+     * @description Retrieves the list of security roles granted to the specified application within a tenant context.
+     */
+    get: operations["GetGrantedTenantRoles"];
   };
-  "/api/v2/Applications/{appID}/GrantedRoles/{SecurityRoleID}/GrantedPermissions": {
-    get: {
-      parameters: {
-        query?: {
-          enrollmentID?: string;
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-        path: {
-          appID: string;
-          securityRoleID: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: never;
-        };
-      };
-    };
+  "/api/v2/Applications/{appId}/GrantedRoles/{securityRoleId}/GrantedPermissions": {
+    /**
+     * Get granted permissions for an application role
+     * @description Retrieves the list of permissions granted through a specific security role for the specified application.
+     */
+    get: operations["GetGrantedEnrollmentPermissions"];
   };
   "/api/v2/Auth/Checker/IsAuthenticated": {
-    get: {
-      parameters: {
-        query?: {
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": boolean;
-            "application/xml": boolean;
-          };
-        };
-      };
-    };
+    /**
+     * Check if user is authenticated
+     * @description Returns whether the current user is authenticated.
+     */
+    get: operations["IsAuthenticated"];
   };
   "/version": {
     get: {
@@ -361,259 +273,58 @@ export interface paths {
     };
   };
   "/api/v2/OAuth/WhoAmI": {
-    get: {
-      parameters: {
-        query?: {
-          tenantId?: string;
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["AuthorizationResultEnvelope"];
-            "application/xml": components["schemas"]["AuthorizationResultEnvelope"];
-          };
-        };
-        /** @description Unauthorized */
-        401: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-        /** @description Forbidden */
-        403: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-      };
-    };
+    /**
+     * Get current user identity
+     * @description Returns the authorization result for the authenticated user, including identity and tenant context.
+     */
+    get: operations["Get"];
   };
   "/api/v2/OAuth/Token": {
-    post: {
-      parameters: {
-        query?: {
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-      };
-      requestBody?: {
-        content: {
-          "application/json": components["schemas"]["OAuthTokenRequest"];
-          "application/xml": components["schemas"]["OAuthTokenRequest"];
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["JsonWebTokenEnvelope"];
-            "application/xml": components["schemas"]["JsonWebTokenEnvelope"];
-          };
-        };
-        /** @description Unauthorized */
-        401: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-        /** @description Forbidden */
-        403: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-      };
-    };
+    /**
+     * Get OAuth token
+     * @description Generates an OAuth token based on the provided credentials or grant type.
+     */
+    post: operations["Token"];
   };
   "/api/v2/OAuth/Permissions": {
-    get: {
-      parameters: {
-        query: {
-          tenantId: string;
-          userId?: string;
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["StringListEnvelope"];
-            "application/xml": components["schemas"]["StringListEnvelope"];
-          };
-        };
-        /** @description Unauthorized */
-        401: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-        /** @description Forbidden */
-        403: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-      };
-    };
+    /**
+     * Get user permissions
+     * @description Retrieves the list of permission identifiers for a specific user within a tenant context.
+     */
+    get: operations["GetPermissions"];
   };
   "/api/v2/OAuth/SignIn": {
-    get: {
-      parameters: {
-        query?: {
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["UserCreateDtoEnvelope"];
-            "application/xml": components["schemas"]["UserCreateDtoEnvelope"];
-          };
-        };
-        /** @description Bad Request */
-        400: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-        /** @description Unauthorized */
-        401: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-      };
-    };
-    post: {
-      parameters: {
-        query?: {
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-      };
-      requestBody?: {
-        content: {
-          "application/json": components["schemas"]["SigninModel"];
-          "application/xml": components["schemas"]["SigninModel"];
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["JsonWebTokenEnvelope"];
-            "application/xml": components["schemas"]["JsonWebTokenEnvelope"];
-          };
-        };
-        /** @description Bad Request */
-        400: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-        /** @description Unauthorized */
-        401: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-      };
-    };
+    /**
+     * Check password sign-in
+     * @description Verifies sign-in credentials and returns user details without creating a session.
+     */
+    get: operations["CheckPasswordSignInAsync"];
+    /**
+     * Sign in with password
+     * @description Authenticates a user using email and password credentials.
+     */
+    post: operations["PasswordSignInAsync"];
   };
   "/api/v2/OAuth/{applicationId}/Keys": {
-    get: {
-      parameters: {
-        query?: {
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-        path: {
-          applicationId: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["JsonWebKeySetEnvelope"];
-            "application/xml": components["schemas"]["JsonWebKeySetEnvelope"];
-          };
-        };
-      };
-    };
+    /**
+     * Get JSON Web Key Set
+     * @description Retrieves the signing keys (JWKS) for a specific application.
+     */
+    get: operations["GetJwKs"];
   };
   "/api/v2/OAuth/{tenantId}/{applicationId}/.Well-Known/OpenId-Configuration": {
-    get: {
-      parameters: {
-        query?: {
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-        path: {
-          tenantId: string;
-          applicationId: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["OpenIdConfigurationEnvelope"];
-            "application/xml": components["schemas"]["OpenIdConfigurationEnvelope"];
-          };
-        };
-      };
-    };
+    /**
+     * Get OpenID configuration
+     * @description Retrieves the OpenID Connect discovery document for a specific application within a tenant.
+     */
+    get: operations["GetOpenIdConfiguration"];
   };
   "/api/v2/IdentityService/Resource/message": {
-    get: {
-      parameters: {
-        query?: {
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: never;
-        };
-      };
-    };
+    /**
+     * Get authenticated resource message
+     * @description Returns a message confirming the authenticated user's identity. Requires the 'abs_api' scope.
+     */
+    get: operations["GetMessage"];
   };
   "/connect/userinfo": {
     get: {
@@ -918,6 +629,148 @@ export type external = Record<string, never>;
 
 export interface operations {
 
+  /**
+   * Get application by ID
+   * @description Retrieves an application by its unique identifier.
+   */
+  GetApplication: {
+    parameters: {
+      query?: {
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+      path: {
+        appId: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: never;
+      };
+    };
+  };
+  /**
+   * Get required permissions for an application
+   * @description Retrieves the list of permissions required by the specified application.
+   */
+  GetRequiredPermissions: {
+    parameters: {
+      query?: {
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+      path: {
+        appId: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: never;
+      };
+    };
+  };
+  /**
+   * Get granted tenant permissions for an application
+   * @description Retrieves the list of permissions granted to the specified application within a tenant context.
+   */
+  GetGrantedTenantPermissions: {
+    parameters: {
+      query?: {
+        tenantId?: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+      path: {
+        appId: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: never;
+      };
+    };
+  };
+  /**
+   * Get granted tenant roles for an application
+   * @description Retrieves the list of security roles granted to the specified application within a tenant context.
+   */
+  GetGrantedTenantRoles: {
+    parameters: {
+      query?: {
+        tenantId?: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+      path: {
+        appId: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: never;
+      };
+    };
+  };
+  /**
+   * Get granted permissions for an application role
+   * @description Retrieves the list of permissions granted through a specific security role for the specified application.
+   */
+  GetGrantedEnrollmentPermissions: {
+    parameters: {
+      query?: {
+        enrollmentId?: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+      path: {
+        appId: string;
+        securityRoleId: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: never;
+      };
+    };
+  };
+  /**
+   * Check if user is authenticated
+   * @description Returns whether the current user is authenticated.
+   */
+  IsAuthenticated: {
+    parameters: {
+      query?: {
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": boolean;
+          "application/xml": boolean;
+        };
+      };
+    };
+  };
   "MapIdentityApi-/confirmEmail": {
     parameters: {
       query: {
@@ -933,4 +786,277 @@ export interface operations {
       };
     };
   };
+  /**
+   * Get current user identity
+   * @description Returns the authorization result for the authenticated user, including identity and tenant context.
+   */
+  Get: {
+    parameters: {
+      query?: {
+        tenantId?: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["AuthorizationResultEnvelope"];
+          "application/xml": components["schemas"]["AuthorizationResultEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Get OAuth token
+   * @description Generates an OAuth token based on the provided credentials or grant type.
+   */
+  Token: {
+    parameters: {
+      query?: {
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+    };
+    requestBody?: {
+      content: {
+        "application/json": components["schemas"]["OAuthTokenRequest"];
+        "application/xml": components["schemas"]["OAuthTokenRequest"];
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["JsonWebTokenEnvelope"];
+          "application/xml": components["schemas"]["JsonWebTokenEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Get user permissions
+   * @description Retrieves the list of permission identifiers for a specific user within a tenant context.
+   */
+  GetPermissions: {
+    parameters: {
+      query: {
+        tenantId: string;
+        userId?: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["StringListEnvelope"];
+          "application/xml": components["schemas"]["StringListEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Check password sign-in
+   * @description Verifies sign-in credentials and returns user details without creating a session.
+   */
+  CheckPasswordSignInAsync: {
+    parameters: {
+      query?: {
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["UserCreateDtoEnvelope"];
+          "application/xml": components["schemas"]["UserCreateDtoEnvelope"];
+        };
+      };
+      /** @description Bad Request */
+      400: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Sign in with password
+   * @description Authenticates a user using email and password credentials.
+   */
+  PasswordSignInAsync: {
+    parameters: {
+      query?: {
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+    };
+    requestBody?: {
+      content: {
+        "application/json": components["schemas"]["SigninModel"];
+        "application/xml": components["schemas"]["SigninModel"];
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["JsonWebTokenEnvelope"];
+          "application/xml": components["schemas"]["JsonWebTokenEnvelope"];
+        };
+      };
+      /** @description Bad Request */
+      400: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Get JSON Web Key Set
+   * @description Retrieves the signing keys (JWKS) for a specific application.
+   */
+  GetJwKs: {
+    parameters: {
+      query?: {
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+      path: {
+        applicationId: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["JsonWebKeySetEnvelope"];
+          "application/xml": components["schemas"]["JsonWebKeySetEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Get OpenID configuration
+   * @description Retrieves the OpenID Connect discovery document for a specific application within a tenant.
+   */
+  GetOpenIdConfiguration: {
+    parameters: {
+      query?: {
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+      path: {
+        tenantId: string;
+        applicationId: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["OpenIdConfigurationEnvelope"];
+          "application/xml": components["schemas"]["OpenIdConfigurationEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Get authenticated resource message
+   * @description Returns a message confirming the authenticated user's identity. Requires the 'abs_api' scope.
+   */
+  GetMessage: {
+    parameters: {
+      query?: {
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: never;
+      };
+    };
+  };
 }