@knowledge-stack/ksapi 1.65.7 → 1.66.1

package/docs/SupportedIdP.md

@@ -0,0 +1,33 @@
+
+# SupportedIdP
+
+Supported external identity providers for tenant-level IdP config.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { SupportedIdP } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies SupportedIdP
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SupportedIdP
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TenantResponse.md

@@ -9,7 +9,7 @@ Name | Type
 ------------ | -------------
 `id` | string
 `name` | string
-`idpConfig` | { [key: string]: string; }
+`idpConfig` | { [key: string]: any; }
 `settings` | [TenantSettingsResponse](TenantSettingsResponse.md)
 `branding` | [TenantBrandingResponse](TenantBrandingResponse.md)
 

package/docs/TenantUserResponse.md

@@ -9,7 +9,11 @@ Name | Type
 ------------ | -------------
 `userId` | string
 `email` | string
+`firstName` | string
+`lastName` | string
 `role` | [TenantUserRole](TenantUserRole.md)
+`deactivatedOn` | Date
+`isTenantIdpManaged` | boolean
 `createdAt` | Date
 `updatedAt` | Date
 
@@ -22,7 +26,11 @@ import type { TenantUserResponse } from '@knowledge-stack/ksapi'
 const example = {
   "userId": null,
   "email": null,
+  "firstName": null,
+  "lastName": null,
   "role": null,
+  "deactivatedOn": null,
+  "isTenantIdpManaged": null,
   "createdAt": null,
   "updatedAt": null,
 } satisfies TenantUserResponse

package/docs/TenantsApi.md

@@ -4,10 +4,11 @@ All URIs are relative to *http://localhost:8000*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**createTenant**](TenantsApi.md#createtenantoperation) | **POST** /v1/tenants | Create Tenant |
+| [**activateTenantUser**](TenantsApi.md#activatetenantuser) | **POST** /v1/tenants/{tenant_id}/users/{user_id}/activate | Activate Tenant User Handler |
+| [**deactivateTenantUser**](TenantsApi.md#deactivatetenantuser) | **POST** /v1/tenants/{tenant_id}/users/{user_id}/deactivate | Deactivate Tenant User Handler |
 | [**deleteTenant**](TenantsApi.md#deletetenant) | **DELETE** /v1/tenants/{tenant_id} | Delete Tenant |
 | [**deleteTenantLogo**](TenantsApi.md#deletetenantlogo) | **DELETE** /v1/tenants/{tenant_id}/branding/logo | Delete Tenant Logo |
-| [**deleteTenantUser**](TenantsApi.md#deletetenantuser) | **DELETE** /v1/tenants/{tenant_id}/users/{user_id} | Delete Tenant User |
+| [**deleteTenantUser**](TenantsApi.md#deletetenantuser) | **DELETE** /v1/tenants/{tenant_id}/users/{user_id} | Delete Tenant User Handler |
 | [**getTenant**](TenantsApi.md#gettenant) | **GET** /v1/tenants/{tenant_id} | Get Tenant |
 | [**listTenantUsers**](TenantsApi.md#listtenantusers) | **GET** /v1/tenants/{tenant_id}/users | List Tenant Users |
 | [**listTenants**](TenantsApi.md#listtenants) | **GET** /v1/tenants | List Tenants |
@@ -17,13 +18,13 @@ All URIs are relative to *http://localhost:8000*
 
 
 
-## createTenant
+## activateTenantUser
 
-> TenantResponse createTenant(createTenantRequest, authorization, ksUat)
+> TenantUserResponse activateTenantUser(tenantId, userId, authorization, ksUat)
 
-Create Tenant
+Activate Tenant User Handler
 
-Create a new tenant.  The creator is automatically added as OWNER of the tenant.
+Reactivate a deactivated tenant user.
 
 ### Example
 
@@ -32,23 +33,25 @@ import {
   Configuration,
   TenantsApi,
 } from '@knowledge-stack/ksapi';
-import type { CreateTenantOperationRequest } from '@knowledge-stack/ksapi';
+import type { ActivateTenantUserRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
   const api = new TenantsApi();
 
   const body = {
-    // CreateTenantRequest
-    createTenantRequest: ...,
+    // string
+    tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    userId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // string (optional)
     authorization: authorization_example,
     // string (optional)
     ksUat: ksUat_example,
-  } satisfies CreateTenantOperationRequest;
+  } satisfies ActivateTenantUserRequest;
 
   try {
-    const data = await api.createTenant(body);
+    const data = await api.activateTenantUser(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -64,13 +67,14 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **createTenantRequest** | [CreateTenantRequest](CreateTenantRequest.md) |  | |
+| **tenantId** | `string` |  | [Defaults to `undefined`] |
+| **userId** | `string` |  | [Defaults to `undefined`] |
 | **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
-[**TenantResponse**](TenantResponse.md)
+[**TenantUserResponse**](TenantUserResponse.md)
 
 ### Authorization
 
@@ -78,14 +82,91 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: `application/json`
+- **Content-Type**: Not defined
 - **Accept**: `application/json`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **201** | Successful Response |  -  |
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deactivateTenantUser
+
+> TenantUserResponse deactivateTenantUser(tenantId, userId, authorization, ksUat)
+
+Deactivate Tenant User Handler
+
+Deactivate a tenant user (soft delete).  The user\'s group memberships in this tenant are permanently removed. They will not be restored on reactivation and must be re-added manually.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TenantsApi,
+} from '@knowledge-stack/ksapi';
+import type { DeactivateTenantUserRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new TenantsApi();
+
+  const body = {
+    // string
+    tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    userId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies DeactivateTenantUserRequest;
+
+  try {
+    const data = await api.deactivateTenantUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tenantId** | `string` |  | [Defaults to `undefined`] |
+| **userId** | `string` |  | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**TenantUserResponse**](TenantUserResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
 | **422** | Validation Error |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
@@ -246,9 +327,9 @@ No authorization required
 
 > deleteTenantUser(tenantId, userId, authorization, ksUat)
 
-Delete Tenant User
+Delete Tenant User Handler
 
-Remove a user from a tenant.  Requires OWNER or ADMIN role. Cannot remove the tenant owner.
+Remove a user from a tenant (hard delete).  Only non-directory-synced users can be removed. Directory-synced users must be managed via directory sync.
 
 ### Example
 

package/docs/UpdateTenantRequest.md

@@ -8,7 +8,7 @@ Update tenant request model.
 Name | Type
 ------------ | -------------
 `name` | string
-`idpConfig` | [OAuth2Config](OAuth2Config.md)
+`idpConfig` | [IdpConfig](IdpConfig.md)
 `settings` | [TenantSettingsUpdate](TenantSettingsUpdate.md)
 
 ## Example

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "1.65.7",
+  "version": "1.66.1",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/AuthApi.ts

@@ -16,6 +16,7 @@
 import * as runtime from '../runtime';
 import type {
   CreatePasswordUserRequest,
+  DirectorySyncResponse,
   EmailSentResponse,
   EmailVerificationRequest,
   HTTPValidationError,
@@ -29,6 +30,8 @@ import type {
 import {
     CreatePasswordUserRequestFromJSON,
     CreatePasswordUserRequestToJSON,
+    DirectorySyncResponseFromJSON,
+    DirectorySyncResponseToJSON,
     EmailSentResponseFromJSON,
     EmailSentResponseToJSON,
     EmailVerificationRequestFromJSON,
@@ -53,6 +56,18 @@ export interface CreatePasswordUserOperationRequest {
     createPasswordUserRequest: CreatePasswordUserRequest;
 }
 
+export interface FanweiDirectorySyncRequest {
+    tenantId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+
+export interface FanweiDirectorySync0Request {
+    tenantId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+
 export interface InitiateSsoRequest {
     provider: IdpType;
     tenantId?: string | null;
@@ -95,6 +110,11 @@ export interface SendPwResetEmailRequest {
     emailVerificationRequest: EmailVerificationRequest;
 }
 
+export interface SsoSigninRequest {
+    tenantId: string;
+    redirect?: string;
+}
+
 /**
  * AuthApi - interface
  * 
@@ -125,6 +145,62 @@ export interface AuthApiInterface {
      */
     createPasswordUser(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
 
+    /**
+     * Creates request options for fanweiDirectorySync without sending the request
+     * @param {string} tenantId 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof AuthApiInterface
+     */
+    fanweiDirectorySyncRequestOpts(requestParameters: FanweiDirectorySyncRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Trigger directory synchronization for a FanWei E9 tenant.  Accepts either: - A logged-in OWNER/ADMIN user (via UAT cookie) - An admin API key (via Authorization: Bearer header)
+     * @summary Directory Sync Handler
+     * @param {string} tenantId 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthApiInterface
+     */
+    fanweiDirectorySyncRaw(requestParameters: FanweiDirectorySyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DirectorySyncResponse>>;
+
+    /**
+     * Trigger directory synchronization for a FanWei E9 tenant.  Accepts either: - A logged-in OWNER/ADMIN user (via UAT cookie) - An admin API key (via Authorization: Bearer header)
+     * Directory Sync Handler
+     */
+    fanweiDirectorySync(requestParameters: FanweiDirectorySyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DirectorySyncResponse>;
+
+    /**
+     * Creates request options for fanweiDirectorySync_1 without sending the request
+     * @param {string} tenantId 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof AuthApiInterface
+     */
+    fanweiDirectorySync_1RequestOpts(requestParameters: FanweiDirectorySync0Request): Promise<runtime.RequestOpts>;
+
+    /**
+     * Trigger directory synchronization for a FanWei E9 tenant.  Accepts either: - A logged-in OWNER/ADMIN user (via UAT cookie) - An admin API key (via Authorization: Bearer header)
+     * @summary Directory Sync Handler
+     * @param {string} tenantId 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthApiInterface
+     */
+    fanweiDirectorySync_1Raw(requestParameters: FanweiDirectorySync0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DirectorySyncResponse>>;
+
+    /**
+     * Trigger directory synchronization for a FanWei E9 tenant.  Accepts either: - A logged-in OWNER/ADMIN user (via UAT cookie) - An admin API key (via Authorization: Bearer header)
+     * Directory Sync Handler
+     */
+    fanweiDirectorySync_1(requestParameters: FanweiDirectorySync0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DirectorySyncResponse>;
+
     /**
      * Creates request options for initiateSso without sending the request
      * @param {IdpType} provider Provider to initiate SSO with
@@ -357,6 +433,32 @@ export interface AuthApiInterface {
      */
     signout(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
 
+    /**
+     * Creates request options for ssoSignin without sending the request
+     * @param {string} tenantId 
+     * @param {string} [redirect] Post-login redirect path
+     * @throws {RequiredError}
+     * @memberof AuthApiInterface
+     */
+    ssoSigninRequestOpts(requestParameters: SsoSigninRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * SSO login endpoint.  Resolves the tenant\'s IdP configuration and dispatches to the appropriate provider-specific handler. Sets the UAT cookie and redirects to the frontend.
+     * @summary Sso Login Handler
+     * @param {string} tenantId 
+     * @param {string} [redirect] Post-login redirect path
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthApiInterface
+     */
+    ssoSigninRaw(requestParameters: SsoSigninRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * SSO login endpoint.  Resolves the tenant\'s IdP configuration and dispatches to the appropriate provider-specific handler. Sets the UAT cookie and redirects to the frontend.
+     * Sso Login Handler
+     */
+    ssoSignin(requestParameters: SsoSigninRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
 }
 
 /**
@@ -411,6 +513,108 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
         return await response.value();
     }
 
+    /**
+     * Creates request options for fanweiDirectorySync without sending the request
+     */
+    async fanweiDirectorySyncRequestOpts(requestParameters: FanweiDirectorySyncRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['tenantId'] == null) {
+            throw new runtime.RequiredError(
+                'tenantId',
+                'Required parameter "tenantId" was null or undefined when calling fanweiDirectorySync().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+
+        let urlPath = `/v1/auth/sso/{tenant_id}/directory_sync`;
+        urlPath = urlPath.replace(`{${"tenant_id"}}`, encodeURIComponent(String(requestParameters['tenantId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Trigger directory synchronization for a FanWei E9 tenant.  Accepts either: - A logged-in OWNER/ADMIN user (via UAT cookie) - An admin API key (via Authorization: Bearer header)
+     * Directory Sync Handler
+     */
+    async fanweiDirectorySyncRaw(requestParameters: FanweiDirectorySyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DirectorySyncResponse>> {
+        const requestOptions = await this.fanweiDirectorySyncRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DirectorySyncResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Trigger directory synchronization for a FanWei E9 tenant.  Accepts either: - A logged-in OWNER/ADMIN user (via UAT cookie) - An admin API key (via Authorization: Bearer header)
+     * Directory Sync Handler
+     */
+    async fanweiDirectorySync(requestParameters: FanweiDirectorySyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DirectorySyncResponse> {
+        const response = await this.fanweiDirectorySyncRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for fanweiDirectorySync_1 without sending the request
+     */
+    async fanweiDirectorySync_1RequestOpts(requestParameters: FanweiDirectorySync0Request): Promise<runtime.RequestOpts> {
+        if (requestParameters['tenantId'] == null) {
+            throw new runtime.RequiredError(
+                'tenantId',
+                'Required parameter "tenantId" was null or undefined when calling fanweiDirectorySync_1().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+
+        let urlPath = `/v1/auth/sso/{tenant_id}/directory_sync`;
+        urlPath = urlPath.replace(`{${"tenant_id"}}`, encodeURIComponent(String(requestParameters['tenantId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Trigger directory synchronization for a FanWei E9 tenant.  Accepts either: - A logged-in OWNER/ADMIN user (via UAT cookie) - An admin API key (via Authorization: Bearer header)
+     * Directory Sync Handler
+     */
+    async fanweiDirectorySync_1Raw(requestParameters: FanweiDirectorySync0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DirectorySyncResponse>> {
+        const requestOptions = await this.fanweiDirectorySync_1RequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DirectorySyncResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Trigger directory synchronization for a FanWei E9 tenant.  Accepts either: - A logged-in OWNER/ADMIN user (via UAT cookie) - An admin API key (via Authorization: Bearer header)
+     * Directory Sync Handler
+     */
+    async fanweiDirectorySync_1(requestParameters: FanweiDirectorySync0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DirectorySyncResponse> {
+        const response = await this.fanweiDirectorySync_1Raw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for initiateSso without sending the request
      */
@@ -870,4 +1074,54 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
         return await response.value();
     }
 
+    /**
+     * Creates request options for ssoSignin without sending the request
+     */
+    async ssoSigninRequestOpts(requestParameters: SsoSigninRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['tenantId'] == null) {
+            throw new runtime.RequiredError(
+                'tenantId',
+                'Required parameter "tenantId" was null or undefined when calling ssoSignin().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['redirect'] != null) {
+            queryParameters['redirect'] = requestParameters['redirect'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/auth/sso/{tenant_id}/signin`;
+        urlPath = urlPath.replace(`{${"tenant_id"}}`, encodeURIComponent(String(requestParameters['tenantId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * SSO login endpoint.  Resolves the tenant\'s IdP configuration and dispatches to the appropriate provider-specific handler. Sets the UAT cookie and redirects to the frontend.
+     * Sso Login Handler
+     */
+    async ssoSigninRaw(requestParameters: SsoSigninRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.ssoSigninRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * SSO login endpoint.  Resolves the tenant\'s IdP configuration and dispatches to the appropriate provider-specific handler. Sets the UAT cookie and redirects to the frontend.
+     * Sso Login Handler
+     */
+    async ssoSignin(requestParameters: SsoSigninRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.ssoSigninRaw(requestParameters, initOverrides);
+    }
+
 }