@emilgroup/auth-sdk 1.33.1-beta.3 → 1.33.1-beta.5

package/.openapi-generator/FILES

@@ -18,6 +18,7 @@ models/create-user-response-class.ts
 models/custom-schema-class.ts
 models/forgot-password-request-dto.ts
 models/get-saml-login-link-request-dto.ts
+models/get-saml-login-link-response-class.ts
 models/get-sso-login-config-request-dto.ts
 models/get-sso-login-config-response-class.ts
 models/index.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/auth-sdk@1.33.1-beta.3 --save
+npm install @emilgroup/auth-sdk@1.33.1-beta.5 --save
 ```
 or 
 ```
-yarn add @emilgroup/auth-sdk@1.33.1-beta.3
+yarn add @emilgroup/auth-sdk@1.33.1-beta.5
 ```
 
 And then you can import ``.

package/api/authservice-api.ts

@@ -31,6 +31,8 @@ import { CreateUserResponseClass } from '../models';
 // @ts-ignore
 import { ForgotPasswordRequestDto } from '../models';
 // @ts-ignore
+import { GetSamlLoginLinkResponseClass } from '../models';
+// @ts-ignore
 import { GetSsoLoginConfigResponseClass } from '../models';
 // @ts-ignore
 import { LoginBySamlRequestDto } from '../models';
@@ -167,8 +169,8 @@ export const AuthserviceApiAxiosParamCreator = function (configuration?: Configu
             };
         },
         /**
-         * Get SAML login link configured for the tenant in cognito as well as tenant settings
-         * @summary Get SAML login link for tenant
+         * Same as login/sso-config, under the field names the login page reads.
+         * @summary Get the SSO login link for a tenant
          * @param {string} tenantSlug 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -206,7 +208,7 @@ export const AuthserviceApiAxiosParamCreator = function (configuration?: Configu
             };
         },
         /**
-         * Returns the hosted UI url the SSO button sends the browser to, together with the identity provider vendor the button is branded with.
+         * Returns the url the SSO button sends the browser to and the identity provider it is branded with, from the tenant SSO connection or, when it has none, the legacy saml settings.
          * @summary Get the SSO login config for a tenant
          * @param {string} tenantSlug 
          * @param {*} [options] Override http request option.
@@ -600,18 +602,18 @@ export const AuthserviceApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * Get SAML login link configured for the tenant in cognito as well as tenant settings
-         * @summary Get SAML login link for tenant
+         * Same as login/sso-config, under the field names the login page reads.
+         * @summary Get the SSO login link for a tenant
          * @param {string} tenantSlug 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getSamlLoginLink(tenantSlug: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+        async getSamlLoginLink(tenantSlug: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSamlLoginLinkResponseClass>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getSamlLoginLink(tenantSlug, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * Returns the hosted UI url the SSO button sends the browser to, together with the identity provider vendor the button is branded with.
+         * Returns the url the SSO button sends the browser to and the identity provider it is branded with, from the tenant SSO connection or, when it has none, the legacy saml settings.
          * @summary Get the SSO login config for a tenant
          * @param {string} tenantSlug 
          * @param {*} [options] Override http request option.
@@ -751,17 +753,17 @@ export const AuthserviceApiFactory = function (configuration?: Configuration, ba
             return localVarFp.forgotPassword(forgotPasswordRequestDto, options).then((request) => request(axios, basePath));
         },
         /**
-         * Get SAML login link configured for the tenant in cognito as well as tenant settings
-         * @summary Get SAML login link for tenant
+         * Same as login/sso-config, under the field names the login page reads.
+         * @summary Get the SSO login link for a tenant
          * @param {string} tenantSlug 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSamlLoginLink(tenantSlug: string, options?: any): AxiosPromise<void> {
+        getSamlLoginLink(tenantSlug: string, options?: any): AxiosPromise<GetSamlLoginLinkResponseClass> {
             return localVarFp.getSamlLoginLink(tenantSlug, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns the hosted UI url the SSO button sends the browser to, together with the identity provider vendor the button is branded with.
+         * Returns the url the SSO button sends the browser to and the identity provider it is branded with, from the tenant SSO connection or, when it has none, the legacy saml settings.
          * @summary Get the SSO login config for a tenant
          * @param {string} tenantSlug 
          * @param {*} [options] Override http request option.
@@ -1087,8 +1089,8 @@ export class AuthserviceApi extends BaseAPI {
     }
 
     /**
-     * Get SAML login link configured for the tenant in cognito as well as tenant settings
-     * @summary Get SAML login link for tenant
+     * Same as login/sso-config, under the field names the login page reads.
+     * @summary Get the SSO login link for a tenant
      * @param {AuthserviceApiGetSamlLoginLinkRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1099,7 +1101,7 @@ export class AuthserviceApi extends BaseAPI {
     }
 
     /**
-     * Returns the hosted UI url the SSO button sends the browser to, together with the identity provider vendor the button is branded with.
+     * Returns the url the SSO button sends the browser to and the identity provider it is branded with, from the tenant SSO connection or, when it has none, the legacy saml settings.
      * @summary Get the SSO login config for a tenant
      * @param {AuthserviceApiGetSsoLoginConfigRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

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

@@ -17,6 +17,7 @@ import { CreateOrgAndUserResponseClass } from '../models';
 import { CreateUserRequestDto } from '../models';
 import { CreateUserResponseClass } from '../models';
 import { ForgotPasswordRequestDto } from '../models';
+import { GetSamlLoginLinkResponseClass } from '../models';
 import { GetSsoLoginConfigResponseClass } from '../models';
 import { LoginBySamlRequestDto } from '../models';
 import { LoginClass } from '../models';
@@ -55,15 +56,15 @@ export declare const AuthserviceApiAxiosParamCreator: (configuration?: Configura
      */
     forgotPassword: (forgotPasswordRequestDto: ForgotPasswordRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Get SAML login link configured for the tenant in cognito as well as tenant settings
-     * @summary Get SAML login link for tenant
+     * Same as login/sso-config, under the field names the login page reads.
+     * @summary Get the SSO login link for a tenant
      * @param {string} tenantSlug
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getSamlLoginLink: (tenantSlug: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns the hosted UI url the SSO button sends the browser to, together with the identity provider vendor the button is branded with.
+     * Returns the url the SSO button sends the browser to and the identity provider it is branded with, from the tenant SSO connection or, when it has none, the legacy saml settings.
      * @summary Get the SSO login config for a tenant
      * @param {string} tenantSlug
      * @param {*} [options] Override http request option.
@@ -166,15 +167,15 @@ export declare const AuthserviceApiFp: (configuration?: Configuration) => {
      */
     forgotPassword(forgotPasswordRequestDto: ForgotPasswordRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * Get SAML login link configured for the tenant in cognito as well as tenant settings
-     * @summary Get SAML login link for tenant
+     * Same as login/sso-config, under the field names the login page reads.
+     * @summary Get the SSO login link for a tenant
      * @param {string} tenantSlug
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSamlLoginLink(tenantSlug: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    getSamlLoginLink(tenantSlug: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSamlLoginLinkResponseClass>>;
     /**
-     * Returns the hosted UI url the SSO button sends the browser to, together with the identity provider vendor the button is branded with.
+     * Returns the url the SSO button sends the browser to and the identity provider it is branded with, from the tenant SSO connection or, when it has none, the legacy saml settings.
      * @summary Get the SSO login config for a tenant
      * @param {string} tenantSlug
      * @param {*} [options] Override http request option.
@@ -277,15 +278,15 @@ export declare const AuthserviceApiFactory: (configuration?: Configuration, base
      */
     forgotPassword(forgotPasswordRequestDto: ForgotPasswordRequestDto, options?: any): AxiosPromise<void>;
     /**
-     * Get SAML login link configured for the tenant in cognito as well as tenant settings
-     * @summary Get SAML login link for tenant
+     * Same as login/sso-config, under the field names the login page reads.
+     * @summary Get the SSO login link for a tenant
      * @param {string} tenantSlug
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSamlLoginLink(tenantSlug: string, options?: any): AxiosPromise<void>;
+    getSamlLoginLink(tenantSlug: string, options?: any): AxiosPromise<GetSamlLoginLinkResponseClass>;
     /**
-     * Returns the hosted UI url the SSO button sends the browser to, together with the identity provider vendor the button is branded with.
+     * Returns the url the SSO button sends the browser to and the identity provider it is branded with, from the tenant SSO connection or, when it has none, the legacy saml settings.
      * @summary Get the SSO login config for a tenant
      * @param {string} tenantSlug
      * @param {*} [options] Override http request option.
@@ -568,16 +569,16 @@ export declare class AuthserviceApi extends BaseAPI {
      */
     forgotPassword(requestParameters: AuthserviceApiForgotPasswordRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
-     * Get SAML login link configured for the tenant in cognito as well as tenant settings
-     * @summary Get SAML login link for tenant
+     * Same as login/sso-config, under the field names the login page reads.
+     * @summary Get the SSO login link for a tenant
      * @param {AuthserviceApiGetSamlLoginLinkRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AuthserviceApi
      */
-    getSamlLoginLink(requestParameters: AuthserviceApiGetSamlLoginLinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    getSamlLoginLink(requestParameters: AuthserviceApiGetSamlLoginLinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSamlLoginLinkResponseClass, any, {}>>;
     /**
-     * Returns the hosted UI url the SSO button sends the browser to, together with the identity provider vendor the button is branded with.
+     * Returns the url the SSO button sends the browser to and the identity provider it is branded with, from the tenant SSO connection or, when it has none, the legacy saml settings.
      * @summary Get the SSO login config for a tenant
      * @param {AuthserviceApiGetSsoLoginConfigRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/api/authservice-api.js

@@ -198,8 +198,8 @@ var AuthserviceApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * Get SAML login link configured for the tenant in cognito as well as tenant settings
-         * @summary Get SAML login link for tenant
+         * Same as login/sso-config, under the field names the login page reads.
+         * @summary Get the SSO login link for a tenant
          * @param {string} tenantSlug
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -234,7 +234,7 @@ var AuthserviceApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * Returns the hosted UI url the SSO button sends the browser to, together with the identity provider vendor the button is branded with.
+         * Returns the url the SSO button sends the browser to and the identity provider it is branded with, from the tenant SSO connection or, when it has none, the legacy saml settings.
          * @summary Get the SSO login config for a tenant
          * @param {string} tenantSlug
          * @param {*} [options] Override http request option.
@@ -627,8 +627,8 @@ var AuthserviceApiFp = function (configuration) {
             });
         },
         /**
-         * Get SAML login link configured for the tenant in cognito as well as tenant settings
-         * @summary Get SAML login link for tenant
+         * Same as login/sso-config, under the field names the login page reads.
+         * @summary Get the SSO login link for a tenant
          * @param {string} tenantSlug
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -647,7 +647,7 @@ var AuthserviceApiFp = function (configuration) {
             });
         },
         /**
-         * Returns the hosted UI url the SSO button sends the browser to, together with the identity provider vendor the button is branded with.
+         * Returns the url the SSO button sends the browser to and the identity provider it is branded with, from the tenant SSO connection or, when it has none, the legacy saml settings.
          * @summary Get the SSO login config for a tenant
          * @param {string} tenantSlug
          * @param {*} [options] Override http request option.
@@ -868,8 +868,8 @@ var AuthserviceApiFactory = function (configuration, basePath, axios) {
             return localVarFp.forgotPassword(forgotPasswordRequestDto, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * Get SAML login link configured for the tenant in cognito as well as tenant settings
-         * @summary Get SAML login link for tenant
+         * Same as login/sso-config, under the field names the login page reads.
+         * @summary Get the SSO login link for a tenant
          * @param {string} tenantSlug
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -878,7 +878,7 @@ var AuthserviceApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getSamlLoginLink(tenantSlug, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * Returns the hosted UI url the SSO button sends the browser to, together with the identity provider vendor the button is branded with.
+         * Returns the url the SSO button sends the browser to and the identity provider it is branded with, from the tenant SSO connection or, when it has none, the legacy saml settings.
          * @summary Get the SSO login config for a tenant
          * @param {string} tenantSlug
          * @param {*} [options] Override http request option.
@@ -1019,8 +1019,8 @@ var AuthserviceApi = /** @class */ (function (_super) {
         return (0, exports.AuthserviceApiFp)(this.configuration).forgotPassword(requestParameters.forgotPasswordRequestDto, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * Get SAML login link configured for the tenant in cognito as well as tenant settings
-     * @summary Get SAML login link for tenant
+     * Same as login/sso-config, under the field names the login page reads.
+     * @summary Get the SSO login link for a tenant
      * @param {AuthserviceApiGetSamlLoginLinkRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1031,7 +1031,7 @@ var AuthserviceApi = /** @class */ (function (_super) {
         return (0, exports.AuthserviceApiFp)(this.configuration).getSamlLoginLink(requestParameters.tenantSlug, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * Returns the hosted UI url the SSO button sends the browser to, together with the identity provider vendor the button is branded with.
+     * Returns the url the SSO button sends the browser to and the identity provider it is branded with, from the tenant SSO connection or, when it has none, the legacy saml settings.
      * @summary Get the SSO login config for a tenant
      * @param {AuthserviceApiGetSsoLoginConfigRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/models/get-saml-login-link-response-class.d.ts

@@ -0,0 +1,42 @@
+/**
+ * EMIL AuthService
+ * The EMIL AuthService 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.
+ */
+/**
+ *
+ * @export
+ * @interface GetSamlLoginLinkResponseClass
+ */
+export interface GetSamlLoginLinkResponseClass {
+    /**
+     * tenant slug
+     * @type {string}
+     * @memberof GetSamlLoginLinkResponseClass
+     */
+    'tenantSlug': string;
+    /**
+     * login link url
+     * @type {string}
+     * @memberof GetSamlLoginLinkResponseClass
+     */
+    'samlIdpLoginUrl': string;
+    /**
+     * Identity Provider id used to brand the SSO button (e.g. \'microsoft\', \'ping\', \'keycloak\').
+     * @type {string}
+     * @memberof GetSamlLoginLinkResponseClass
+     */
+    'provider'?: string;
+    /**
+     * True when the tenant still logs in through the legacy saml settings.
+     * @type {boolean}
+     * @memberof GetSamlLoginLinkResponseClass
+     */
+    'isLegacy': boolean;
+}

package/dist/models/get-saml-login-link-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL AuthService
+ * The EMIL AuthService 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/get-sso-login-config-response-class.d.ts

@@ -39,4 +39,10 @@ export interface GetSsoLoginConfigResponseClass {
      * @memberof GetSsoLoginConfigResponseClass
      */
     'protocol'?: string;
+    /**
+     * True when the tenant still logs in through the legacy saml settings.
+     * @type {boolean}
+     * @memberof GetSsoLoginConfigResponseClass
+     */
+    'isLegacy': boolean;
 }

package/dist/models/index.d.ts

@@ -5,6 +5,7 @@ export * from './create-user-response-class';
 export * from './custom-schema-class';
 export * from './forgot-password-request-dto';
 export * from './get-saml-login-link-request-dto';
+export * from './get-saml-login-link-response-class';
 export * from './get-sso-login-config-request-dto';
 export * from './get-sso-login-config-response-class';
 export * from './inline-response200';

package/dist/models/index.js

@@ -21,6 +21,7 @@ __exportStar(require("./create-user-response-class"), exports);
 __exportStar(require("./custom-schema-class"), exports);
 __exportStar(require("./forgot-password-request-dto"), exports);
 __exportStar(require("./get-saml-login-link-request-dto"), exports);
+__exportStar(require("./get-saml-login-link-response-class"), exports);
 __exportStar(require("./get-sso-login-config-request-dto"), exports);
 __exportStar(require("./get-sso-login-config-response-class"), exports);
 __exportStar(require("./inline-response200"), exports);

package/models/get-saml-login-link-response-class.ts

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL AuthService
+ * The EMIL AuthService 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface GetSamlLoginLinkResponseClass
+ */
+export interface GetSamlLoginLinkResponseClass {
+    /**
+     * tenant slug
+     * @type {string}
+     * @memberof GetSamlLoginLinkResponseClass
+     */
+    'tenantSlug': string;
+    /**
+     * login link url
+     * @type {string}
+     * @memberof GetSamlLoginLinkResponseClass
+     */
+    'samlIdpLoginUrl': string;
+    /**
+     * Identity Provider id used to brand the SSO button (e.g. \'microsoft\', \'ping\', \'keycloak\').
+     * @type {string}
+     * @memberof GetSamlLoginLinkResponseClass
+     */
+    'provider'?: string;
+    /**
+     * True when the tenant still logs in through the legacy saml settings.
+     * @type {boolean}
+     * @memberof GetSamlLoginLinkResponseClass
+     */
+    'isLegacy': boolean;
+}
+

package/models/get-sso-login-config-response-class.ts

@@ -44,5 +44,11 @@ export interface GetSsoLoginConfigResponseClass {
      * @memberof GetSsoLoginConfigResponseClass
      */
     'protocol'?: string;
+    /**
+     * True when the tenant still logs in through the legacy saml settings.
+     * @type {boolean}
+     * @memberof GetSsoLoginConfigResponseClass
+     */
+    'isLegacy': boolean;
 }
 

package/models/index.ts

@@ -5,6 +5,7 @@ export * from './create-user-response-class';
 export * from './custom-schema-class';
 export * from './forgot-password-request-dto';
 export * from './get-saml-login-link-request-dto';
+export * from './get-saml-login-link-response-class';
 export * from './get-sso-login-config-request-dto';
 export * from './get-sso-login-config-response-class';
 export * from './inline-response200';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emilgroup/auth-sdk",
-  "version": "1.33.1-beta.3",
+  "version": "1.33.1-beta.5",
   "description": "OpenAPI client for @emilgroup/auth-sdk",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [