@emilgroup/tenant-sdk 1.42.1-beta.24 → 1.42.1-beta.26

package/.openapi-generator/FILES

@@ -118,6 +118,7 @@ models/list-user-group-members-response-class.ts
 models/list-user-groups-response-class.ts
 models/list-users-response-class.ts
 models/oidc-sso-details-input-dto.ts
+models/oidc-sso-details-update-dto.ts
 models/org-invitation-class.ts
 models/org-invitation-response-class.ts
 models/organization-class.ts
@@ -163,6 +164,8 @@ models/update-organization-request-dto-rest.ts
 models/update-organization-response-class.ts
 models/update-report-schedule-request-dto.ts
 models/update-report-schedule-response-class.ts
+models/update-sso-connection-body-dto.ts
+models/update-sso-connection-response-class.ts
 models/update-sso-connection-status-body-dto.ts
 models/update-sso-connection-status-response-class.ts
 models/update-user-group-request-dto.ts

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/tenant-sdk@1.42.1-beta.24 --save
+npm install @emilgroup/tenant-sdk@1.42.1-beta.26 --save
 ```
 or 
 ```
-yarn add @emilgroup/tenant-sdk@1.42.1-beta.24
+yarn add @emilgroup/tenant-sdk@1.42.1-beta.26
 ```
 
 And then you can import `UsersApi`.

package/api/ssoconnection-api.ts

@@ -25,8 +25,14 @@ import { CreateSsoConnectionRequestDto } from '../models';
 // @ts-ignore
 import { CreateSsoConnectionResponseClass } from '../models';
 // @ts-ignore
+import { DeleteResponseClass } from '../models';
+// @ts-ignore
 import { GetSsoConnectionResponseClass } from '../models';
 // @ts-ignore
+import { UpdateSsoConnectionBodyDto } from '../models';
+// @ts-ignore
+import { UpdateSsoConnectionResponseClass } from '../models';
+// @ts-ignore
 import { UpdateSsoConnectionStatusBodyDto } from '../models';
 // @ts-ignore
 import { UpdateSsoConnectionStatusResponseClass } from '../models';
@@ -83,6 +89,92 @@ export const SSOConnectionApiAxiosParamCreator = function (configuration?: Confi
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Removes the configuration, so the tenant can be configured again from scratch. Only an inactive connection can be deleted, so deactivate it first: deleting a live one would lock every SSO user out of the tenant. Custom attributes an attribute mapping provisioned stay on the user pool permanently, because Cognito cannot remove them.  **Required Permissions**  \"tenant-management.settings.delete\"
+         * @summary Delete the tenant\'s SSO connection
+         * @param {string} code Connection code.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteSsoConnection: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('deleteSsoConnection', 'code', code)
+            const localVarPath = `/tenantservice/v1/sso-connection/{code}`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Returns the SSO connection of the calling tenant. A tenant has at most one connection, so no code has to be known up front. Responds with a not found when the tenant has never configured one.  **Required Permissions**  \"tenant-management.settings.view\"
+         * @summary Read the tenant\'s current SSO connection
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCurrentSsoConnection: async (authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/tenantservice/v1/sso-connection/current`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Returns the SSO Connection entity identified by code  **Required Permissions**  \"tenant-management.settings.view\"
          * @summary Read the tenant\'s SSO connection
@@ -128,6 +220,57 @@ export const SSOConnectionApiAxiosParamCreator = function (configuration?: Confi
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Replaces the display name, identity provider details and the claim mapping. The protocol and the provider are fixed for the lifetime of a connection. Editing is only allowed while the connection is inactive, so deactivate it first. Leaving the OIDC client secret out keeps the stored one, and an edit never activates the connection.  **Required Permissions**  \"tenant-management.settings.update\"
+         * @summary Edit the tenant\'s SSO connection
+         * @param {string} code Connection code.
+         * @param {UpdateSsoConnectionBodyDto} updateSsoConnectionBodyDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateSsoConnection: async (code: string, updateSsoConnectionBodyDto: UpdateSsoConnectionBodyDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('updateSsoConnection', 'code', code)
+            // verify required parameter 'updateSsoConnectionBodyDto' is not null or undefined
+            assertParamExists('updateSsoConnection', 'updateSsoConnectionBodyDto', updateSsoConnectionBodyDto)
+            const localVarPath = `/tenantservice/v1/sso-connection/{code}`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(updateSsoConnectionBodyDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Activates and deactivates SSO connection status.  **Required Permissions**  \"tenant-management.settings.update\"
          * @summary Switch the tenant\'s SSO connection on or off
@@ -201,6 +344,29 @@ export const SSOConnectionApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.createSsoConnection(createSsoConnectionRequestDto, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Removes the configuration, so the tenant can be configured again from scratch. Only an inactive connection can be deleted, so deactivate it first: deleting a live one would lock every SSO user out of the tenant. Custom attributes an attribute mapping provisioned stay on the user pool permanently, because Cognito cannot remove them.  **Required Permissions**  \"tenant-management.settings.delete\"
+         * @summary Delete the tenant\'s SSO connection
+         * @param {string} code Connection code.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async deleteSsoConnection(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSsoConnection(code, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Returns the SSO connection of the calling tenant. A tenant has at most one connection, so no code has to be known up front. Responds with a not found when the tenant has never configured one.  **Required Permissions**  \"tenant-management.settings.view\"
+         * @summary Read the tenant\'s current SSO connection
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getCurrentSsoConnection(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSsoConnectionResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getCurrentSsoConnection(authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Returns the SSO Connection entity identified by code  **Required Permissions**  \"tenant-management.settings.view\"
          * @summary Read the tenant\'s SSO connection
@@ -213,6 +379,19 @@ export const SSOConnectionApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getSsoConnection(code, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Replaces the display name, identity provider details and the claim mapping. The protocol and the provider are fixed for the lifetime of a connection. Editing is only allowed while the connection is inactive, so deactivate it first. Leaving the OIDC client secret out keeps the stored one, and an edit never activates the connection.  **Required Permissions**  \"tenant-management.settings.update\"
+         * @summary Edit the tenant\'s SSO connection
+         * @param {string} code Connection code.
+         * @param {UpdateSsoConnectionBodyDto} updateSsoConnectionBodyDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async updateSsoConnection(code: string, updateSsoConnectionBodyDto: UpdateSsoConnectionBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateSsoConnectionResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.updateSsoConnection(code, updateSsoConnectionBodyDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Activates and deactivates SSO connection status.  **Required Permissions**  \"tenant-management.settings.update\"
          * @summary Switch the tenant\'s SSO connection on or off
@@ -247,6 +426,27 @@ export const SSOConnectionApiFactory = function (configuration?: Configuration,
         createSsoConnection(createSsoConnectionRequestDto: CreateSsoConnectionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateSsoConnectionResponseClass> {
             return localVarFp.createSsoConnection(createSsoConnectionRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Removes the configuration, so the tenant can be configured again from scratch. Only an inactive connection can be deleted, so deactivate it first: deleting a live one would lock every SSO user out of the tenant. Custom attributes an attribute mapping provisioned stay on the user pool permanently, because Cognito cannot remove them.  **Required Permissions**  \"tenant-management.settings.delete\"
+         * @summary Delete the tenant\'s SSO connection
+         * @param {string} code Connection code.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteSsoConnection(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass> {
+            return localVarFp.deleteSsoConnection(code, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns the SSO connection of the calling tenant. A tenant has at most one connection, so no code has to be known up front. Responds with a not found when the tenant has never configured one.  **Required Permissions**  \"tenant-management.settings.view\"
+         * @summary Read the tenant\'s current SSO connection
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCurrentSsoConnection(authorization?: string, options?: any): AxiosPromise<GetSsoConnectionResponseClass> {
+            return localVarFp.getCurrentSsoConnection(authorization, options).then((request) => request(axios, basePath));
+        },
         /**
          * Returns the SSO Connection entity identified by code  **Required Permissions**  \"tenant-management.settings.view\"
          * @summary Read the tenant\'s SSO connection
@@ -258,6 +458,18 @@ export const SSOConnectionApiFactory = function (configuration?: Configuration,
         getSsoConnection(code: string, authorization?: string, options?: any): AxiosPromise<GetSsoConnectionResponseClass> {
             return localVarFp.getSsoConnection(code, authorization, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Replaces the display name, identity provider details and the claim mapping. The protocol and the provider are fixed for the lifetime of a connection. Editing is only allowed while the connection is inactive, so deactivate it first. Leaving the OIDC client secret out keeps the stored one, and an edit never activates the connection.  **Required Permissions**  \"tenant-management.settings.update\"
+         * @summary Edit the tenant\'s SSO connection
+         * @param {string} code Connection code.
+         * @param {UpdateSsoConnectionBodyDto} updateSsoConnectionBodyDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateSsoConnection(code: string, updateSsoConnectionBodyDto: UpdateSsoConnectionBodyDto, authorization?: string, options?: any): AxiosPromise<UpdateSsoConnectionResponseClass> {
+            return localVarFp.updateSsoConnection(code, updateSsoConnectionBodyDto, authorization, options).then((request) => request(axios, basePath));
+        },
         /**
          * Activates and deactivates SSO connection status.  **Required Permissions**  \"tenant-management.settings.update\"
          * @summary Switch the tenant\'s SSO connection on or off
@@ -294,6 +506,41 @@ export interface SSOConnectionApiCreateSsoConnectionRequest {
     readonly authorization?: string
 }
 
+/**
+ * Request parameters for deleteSsoConnection operation in SSOConnectionApi.
+ * @export
+ * @interface SSOConnectionApiDeleteSsoConnectionRequest
+ */
+export interface SSOConnectionApiDeleteSsoConnectionRequest {
+    /**
+     * Connection code.
+     * @type {string}
+     * @memberof SSOConnectionApiDeleteSsoConnection
+     */
+    readonly code: string
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof SSOConnectionApiDeleteSsoConnection
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for getCurrentSsoConnection operation in SSOConnectionApi.
+ * @export
+ * @interface SSOConnectionApiGetCurrentSsoConnectionRequest
+ */
+export interface SSOConnectionApiGetCurrentSsoConnectionRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof SSOConnectionApiGetCurrentSsoConnection
+     */
+    readonly authorization?: string
+}
+
 /**
  * Request parameters for getSsoConnection operation in SSOConnectionApi.
  * @export
@@ -315,6 +562,34 @@ export interface SSOConnectionApiGetSsoConnectionRequest {
     readonly authorization?: string
 }
 
+/**
+ * Request parameters for updateSsoConnection operation in SSOConnectionApi.
+ * @export
+ * @interface SSOConnectionApiUpdateSsoConnectionRequest
+ */
+export interface SSOConnectionApiUpdateSsoConnectionRequest {
+    /**
+     * Connection code.
+     * @type {string}
+     * @memberof SSOConnectionApiUpdateSsoConnection
+     */
+    readonly code: string
+
+    /**
+     * 
+     * @type {UpdateSsoConnectionBodyDto}
+     * @memberof SSOConnectionApiUpdateSsoConnection
+     */
+    readonly updateSsoConnectionBodyDto: UpdateSsoConnectionBodyDto
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof SSOConnectionApiUpdateSsoConnection
+     */
+    readonly authorization?: string
+}
+
 /**
  * Request parameters for updateSsoConnectionStatus operation in SSOConnectionApi.
  * @export
@@ -362,6 +637,30 @@ export class SSOConnectionApi extends BaseAPI {
         return SSOConnectionApiFp(this.configuration).createSsoConnection(requestParameters.createSsoConnectionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Removes the configuration, so the tenant can be configured again from scratch. Only an inactive connection can be deleted, so deactivate it first: deleting a live one would lock every SSO user out of the tenant. Custom attributes an attribute mapping provisioned stay on the user pool permanently, because Cognito cannot remove them.  **Required Permissions**  \"tenant-management.settings.delete\"
+     * @summary Delete the tenant\'s SSO connection
+     * @param {SSOConnectionApiDeleteSsoConnectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SSOConnectionApi
+     */
+    public deleteSsoConnection(requestParameters: SSOConnectionApiDeleteSsoConnectionRequest, options?: AxiosRequestConfig) {
+        return SSOConnectionApiFp(this.configuration).deleteSsoConnection(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Returns the SSO connection of the calling tenant. A tenant has at most one connection, so no code has to be known up front. Responds with a not found when the tenant has never configured one.  **Required Permissions**  \"tenant-management.settings.view\"
+     * @summary Read the tenant\'s current SSO connection
+     * @param {SSOConnectionApiGetCurrentSsoConnectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SSOConnectionApi
+     */
+    public getCurrentSsoConnection(requestParameters: SSOConnectionApiGetCurrentSsoConnectionRequest = {}, options?: AxiosRequestConfig) {
+        return SSOConnectionApiFp(this.configuration).getCurrentSsoConnection(requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Returns the SSO Connection entity identified by code  **Required Permissions**  \"tenant-management.settings.view\"
      * @summary Read the tenant\'s SSO connection
@@ -374,6 +673,18 @@ export class SSOConnectionApi extends BaseAPI {
         return SSOConnectionApiFp(this.configuration).getSsoConnection(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Replaces the display name, identity provider details and the claim mapping. The protocol and the provider are fixed for the lifetime of a connection. Editing is only allowed while the connection is inactive, so deactivate it first. Leaving the OIDC client secret out keeps the stored one, and an edit never activates the connection.  **Required Permissions**  \"tenant-management.settings.update\"
+     * @summary Edit the tenant\'s SSO connection
+     * @param {SSOConnectionApiUpdateSsoConnectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SSOConnectionApi
+     */
+    public updateSsoConnection(requestParameters: SSOConnectionApiUpdateSsoConnectionRequest, options?: AxiosRequestConfig) {
+        return SSOConnectionApiFp(this.configuration).updateSsoConnection(requestParameters.code, requestParameters.updateSsoConnectionBodyDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Activates and deactivates SSO connection status.  **Required Permissions**  \"tenant-management.settings.update\"
      * @summary Switch the tenant\'s SSO connection on or off