@emilgroup/tenant-sdk-node 1.39.1-beta.21 → 1.39.1-beta.23

package/.openapi-generator/FILES

@@ -21,6 +21,7 @@ api/report-schedule-api.ts
 api/report-schedule-logs-api.ts
 api/roles-api.ts
 api/settings-api.ts
+api/ssoconnection-api.ts
 api/user-controller-rest-api.ts
 api/user-group-api.ts
 api/users-api.ts
@@ -52,6 +53,8 @@ models/create-organization-migration-response-class.ts
 models/create-report-schedule-request-dto.ts
 models/create-report-schedule-response-class.ts
 models/create-resources-migration-request-dto.ts
+models/create-sso-connection-request-dto.ts
+models/create-sso-connection-response-class.ts
 models/create-tenant-request-dto.ts
 models/create-user-group-request-dto.ts
 models/create-user-group-response-class.ts
@@ -85,6 +88,7 @@ models/get-organization-migration-response-class.ts
 models/get-organization-response-class.ts
 models/get-report-schedule-response-class.ts
 models/get-settings-response-class.ts
+models/get-sso-connection-response-class.ts
 models/get-user-group-response-class.ts
 models/get-user-response-class.ts
 models/index.ts
@@ -113,6 +117,7 @@ models/list-roles-response-class.ts
 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/org-invitation-class.ts
 models/org-invitation-response-class.ts
 models/organization-class.ts
@@ -133,10 +138,16 @@ models/revert-organization-migration-response-class.ts
 models/role-class.ts
 models/run-data-report-request-dto.ts
 models/run-data-report-response-class.ts
+models/saml-sso-details-dto.ts
 models/set-setting-grpc-request-dto.ts
 models/set-setting-request-dto.ts
 models/set-tenant-setting-response-class.ts
 models/set-user-setting-response-class.ts
+models/shared-oidc-sso-details-class.ts
+models/shared-saml-sso-details-class.ts
+models/shared-sso-attribute-mapping-class.ts
+models/sso-attribute-mapping-dto.ts
+models/sso-connection-class.ts
 models/subscription-class.ts
 models/tenant-admin-user-dto.ts
 models/tenant-settings-class.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-node@1.39.1-beta.21 --save
+npm install @emilgroup/tenant-sdk-node@1.39.1-beta.23 --save
 ```
 or 
 ```
-yarn add @emilgroup/tenant-sdk-node@1.39.1-beta.21
+yarn add @emilgroup/tenant-sdk-node@1.39.1-beta.23
 ```
 
 And then you can import `UsersApi`.

package/api/ssoconnection-api.ts

@@ -0,0 +1,272 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+// @ts-ignore
+import { CreateSsoConnectionRequestDto } from '../models';
+// @ts-ignore
+import { CreateSsoConnectionResponseClass } from '../models';
+// @ts-ignore
+import { GetSsoConnectionResponseClass } from '../models';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+const FormData = require('form-data');
+/**
+ * SSOConnectionApi - axios parameter creator
+ * @export
+ */
+export const SSOConnectionApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Validates the identity provider data, stores the configuration, and prepares the tenant\'s Cognito user pool for the mapped claims. The connection is created inactive: activating it is a separate action. One connection per tenant.  **Required Permissions**  \"tenant-management.settings.create\"
+         * @summary Create the tenant\'s SSO connection
+         * @param {CreateSsoConnectionRequestDto} createSsoConnectionRequestDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createSsoConnection: async (createSsoConnectionRequestDto: CreateSsoConnectionRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'createSsoConnectionRequestDto' is not null or undefined
+            assertParamExists('createSsoConnection', 'createSsoConnectionRequestDto', createSsoConnectionRequestDto)
+            const localVarPath = `/tenantservice/v1/sso-connection`;
+            // 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: 'POST', ...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(createSsoConnectionRequestDto, localVarRequestOptions, configuration)
+
+            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
+         * @param {string} code Connection code.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSsoConnection: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('getSsoConnection', '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: '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,
+            };
+        },
+    }
+};
+
+/**
+ * SSOConnectionApi - functional programming interface
+ * @export
+ */
+export const SSOConnectionApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = SSOConnectionApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Validates the identity provider data, stores the configuration, and prepares the tenant\'s Cognito user pool for the mapped claims. The connection is created inactive: activating it is a separate action. One connection per tenant.  **Required Permissions**  \"tenant-management.settings.create\"
+         * @summary Create the tenant\'s SSO connection
+         * @param {CreateSsoConnectionRequestDto} createSsoConnectionRequestDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createSsoConnection(createSsoConnectionRequestDto: CreateSsoConnectionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSsoConnectionResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createSsoConnection(createSsoConnectionRequestDto, 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
+         * @param {string} code Connection code.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getSsoConnection(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSsoConnectionResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getSsoConnection(code, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * SSOConnectionApi - factory interface
+ * @export
+ */
+export const SSOConnectionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = SSOConnectionApiFp(configuration)
+    return {
+        /**
+         * Validates the identity provider data, stores the configuration, and prepares the tenant\'s Cognito user pool for the mapped claims. The connection is created inactive: activating it is a separate action. One connection per tenant.  **Required Permissions**  \"tenant-management.settings.create\"
+         * @summary Create the tenant\'s SSO connection
+         * @param {CreateSsoConnectionRequestDto} createSsoConnectionRequestDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createSsoConnection(createSsoConnectionRequestDto: CreateSsoConnectionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateSsoConnectionResponseClass> {
+            return localVarFp.createSsoConnection(createSsoConnectionRequestDto, 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
+         * @param {string} code Connection code.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSsoConnection(code: string, authorization?: string, options?: any): AxiosPromise<GetSsoConnectionResponseClass> {
+            return localVarFp.getSsoConnection(code, authorization, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for createSsoConnection operation in SSOConnectionApi.
+ * @export
+ * @interface SSOConnectionApiCreateSsoConnectionRequest
+ */
+export interface SSOConnectionApiCreateSsoConnectionRequest {
+    /**
+     * 
+     * @type {CreateSsoConnectionRequestDto}
+     * @memberof SSOConnectionApiCreateSsoConnection
+     */
+    readonly createSsoConnectionRequestDto: CreateSsoConnectionRequestDto
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof SSOConnectionApiCreateSsoConnection
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for getSsoConnection operation in SSOConnectionApi.
+ * @export
+ * @interface SSOConnectionApiGetSsoConnectionRequest
+ */
+export interface SSOConnectionApiGetSsoConnectionRequest {
+    /**
+     * Connection code.
+     * @type {string}
+     * @memberof SSOConnectionApiGetSsoConnection
+     */
+    readonly code: string
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof SSOConnectionApiGetSsoConnection
+     */
+    readonly authorization?: string
+}
+
+/**
+ * SSOConnectionApi - object-oriented interface
+ * @export
+ * @class SSOConnectionApi
+ * @extends {BaseAPI}
+ */
+export class SSOConnectionApi extends BaseAPI {
+    /**
+     * Validates the identity provider data, stores the configuration, and prepares the tenant\'s Cognito user pool for the mapped claims. The connection is created inactive: activating it is a separate action. One connection per tenant.  **Required Permissions**  \"tenant-management.settings.create\"
+     * @summary Create the tenant\'s SSO connection
+     * @param {SSOConnectionApiCreateSsoConnectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SSOConnectionApi
+     */
+    public createSsoConnection(requestParameters: SSOConnectionApiCreateSsoConnectionRequest, options?: AxiosRequestConfig) {
+        return SSOConnectionApiFp(this.configuration).createSsoConnection(requestParameters.createSsoConnectionRequestDto, 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
+     * @param {SSOConnectionApiGetSsoConnectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SSOConnectionApi
+     */
+    public getSsoConnection(requestParameters: SSOConnectionApiGetSsoConnectionRequest, options?: AxiosRequestConfig) {
+        return SSOConnectionApiFp(this.configuration).getSsoConnection(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/api.ts

@@ -41,6 +41,7 @@ import { ReInviteAnOrganizationApi } from './api';
 import { ReportScheduleApi } from './api';
 import { ReportScheduleLogsApi } from './api';
 import { RolesApi } from './api';
+import { SSOConnectionApi } from './api';
 import { SettingsApi } from './api';
 import { UserControllerRestApi } from './api';
 import { UserGroupApi } from './api';
@@ -64,6 +65,7 @@ export * from './api/re-invite-an-organization-api';
 export * from './api/report-schedule-api';
 export * from './api/report-schedule-logs-api';
 export * from './api/roles-api';
+export * from './api/ssoconnection-api';
 export * from './api/settings-api';
 export * from './api/user-controller-rest-api';
 export * from './api/user-group-api';

package/dist/api/ssoconnection-api.d.ts

@@ -0,0 +1,153 @@
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreateSsoConnectionRequestDto } from '../models';
+import { CreateSsoConnectionResponseClass } from '../models';
+import { GetSsoConnectionResponseClass } from '../models';
+/**
+ * SSOConnectionApi - axios parameter creator
+ * @export
+ */
+export declare const SSOConnectionApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Validates the identity provider data, stores the configuration, and prepares the tenant\'s Cognito user pool for the mapped claims. The connection is created inactive: activating it is a separate action. One connection per tenant.  **Required Permissions**  \"tenant-management.settings.create\"
+     * @summary Create the tenant\'s SSO connection
+     * @param {CreateSsoConnectionRequestDto} createSsoConnectionRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSsoConnection: (createSsoConnectionRequestDto: CreateSsoConnectionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns the SSO Connection entity identified by code  **Required Permissions**  \"tenant-management.settings.view\"
+     * @summary Read the tenant\'s SSO connection
+     * @param {string} code Connection code.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSsoConnection: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * SSOConnectionApi - functional programming interface
+ * @export
+ */
+export declare const SSOConnectionApiFp: (configuration?: Configuration) => {
+    /**
+     * Validates the identity provider data, stores the configuration, and prepares the tenant\'s Cognito user pool for the mapped claims. The connection is created inactive: activating it is a separate action. One connection per tenant.  **Required Permissions**  \"tenant-management.settings.create\"
+     * @summary Create the tenant\'s SSO connection
+     * @param {CreateSsoConnectionRequestDto} createSsoConnectionRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSsoConnection(createSsoConnectionRequestDto: CreateSsoConnectionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSsoConnectionResponseClass>>;
+    /**
+     * Returns the SSO Connection entity identified by code  **Required Permissions**  \"tenant-management.settings.view\"
+     * @summary Read the tenant\'s SSO connection
+     * @param {string} code Connection code.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSsoConnection(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSsoConnectionResponseClass>>;
+};
+/**
+ * SSOConnectionApi - factory interface
+ * @export
+ */
+export declare const SSOConnectionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Validates the identity provider data, stores the configuration, and prepares the tenant\'s Cognito user pool for the mapped claims. The connection is created inactive: activating it is a separate action. One connection per tenant.  **Required Permissions**  \"tenant-management.settings.create\"
+     * @summary Create the tenant\'s SSO connection
+     * @param {CreateSsoConnectionRequestDto} createSsoConnectionRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSsoConnection(createSsoConnectionRequestDto: CreateSsoConnectionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateSsoConnectionResponseClass>;
+    /**
+     * Returns the SSO Connection entity identified by code  **Required Permissions**  \"tenant-management.settings.view\"
+     * @summary Read the tenant\'s SSO connection
+     * @param {string} code Connection code.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSsoConnection(code: string, authorization?: string, options?: any): AxiosPromise<GetSsoConnectionResponseClass>;
+};
+/**
+ * Request parameters for createSsoConnection operation in SSOConnectionApi.
+ * @export
+ * @interface SSOConnectionApiCreateSsoConnectionRequest
+ */
+export interface SSOConnectionApiCreateSsoConnectionRequest {
+    /**
+     *
+     * @type {CreateSsoConnectionRequestDto}
+     * @memberof SSOConnectionApiCreateSsoConnection
+     */
+    readonly createSsoConnectionRequestDto: CreateSsoConnectionRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof SSOConnectionApiCreateSsoConnection
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getSsoConnection operation in SSOConnectionApi.
+ * @export
+ * @interface SSOConnectionApiGetSsoConnectionRequest
+ */
+export interface SSOConnectionApiGetSsoConnectionRequest {
+    /**
+     * Connection code.
+     * @type {string}
+     * @memberof SSOConnectionApiGetSsoConnection
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof SSOConnectionApiGetSsoConnection
+     */
+    readonly authorization?: string;
+}
+/**
+ * SSOConnectionApi - object-oriented interface
+ * @export
+ * @class SSOConnectionApi
+ * @extends {BaseAPI}
+ */
+export declare class SSOConnectionApi extends BaseAPI {
+    /**
+     * Validates the identity provider data, stores the configuration, and prepares the tenant\'s Cognito user pool for the mapped claims. The connection is created inactive: activating it is a separate action. One connection per tenant.  **Required Permissions**  \"tenant-management.settings.create\"
+     * @summary Create the tenant\'s SSO connection
+     * @param {SSOConnectionApiCreateSsoConnectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SSOConnectionApi
+     */
+    createSsoConnection(requestParameters: SSOConnectionApiCreateSsoConnectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateSsoConnectionResponseClass, any, {}>>;
+    /**
+     * Returns the SSO Connection entity identified by code  **Required Permissions**  \"tenant-management.settings.view\"
+     * @summary Read the tenant\'s SSO connection
+     * @param {SSOConnectionApiGetSsoConnectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SSOConnectionApi
+     */
+    getSsoConnection(requestParameters: SSOConnectionApiGetSsoConnectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSsoConnectionResponseClass, any, {}>>;
+}