/** * 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. */ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { CreateOrgAndUserRequestDto } from '../models'; import { CreateOrgAndUserResponseClass } from '../models'; import { CreateUserRequestDto } from '../models'; import { CreateUserResponseClass } from '../models'; import { ForgotPasswordRequestDto } from '../models'; import { LoginBySamlRequestDto } from '../models'; import { LoginClass } from '../models'; import { LoginRequestDto } from '../models'; import { LogoutRequestDto } from '../models'; import { RefreshTokenDto } from '../models'; import { ResetPasswordRequestDto } from '../models'; import { VerifyOrgInvitationResponseClass } from '../models'; /** * AuthserviceApi - axios parameter creator * @export */ export declare const AuthserviceApiAxiosParamCreator: (configuration?: Configuration) => { /** * Register a new organization with appropriate hierarchy and create a user for that organization. * @summary Register Organization and User using invitation token * @param {CreateOrgAndUserRequestDto} createOrgAndUserRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrgAndUser: (createOrgAndUserRequestDto: CreateOrgAndUserRequestDto, options?: AxiosRequestConfig) => Promise; /** * Register a tenant user using the invite token sent to the tenant user\'s email address. * @summary Register tenant user after invite * @param {CreateUserRequestDto} createUserRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUser: (createUserRequestDto: CreateUserRequestDto, options?: AxiosRequestConfig) => Promise; /** * Send a tenant user a reset-password token via email. * @summary Forgot password by tenant * @param {ForgotPasswordRequestDto} forgotPasswordRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ forgotPassword: (forgotPasswordRequestDto: ForgotPasswordRequestDto, options?: AxiosRequestConfig) => Promise; /** * Get SAML login link configured for the tenant in cognito as well as tenant settings * @summary Get SAML login link for tenant * @param {string} tenantSlug * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSamlLoginLink: (tenantSlug: string, options?: AxiosRequestConfig) => Promise; /** * Get new access token, refresh token after successful login. * @summary Login by tenant * @param {LoginRequestDto} loginRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ login: (loginRequestDto: LoginRequestDto, options?: AxiosRequestConfig) => Promise; /** * Get new access token, refresh token after successful login. This api also creates a tenant user if user does not exist * @summary Login by SAML idp provider such as ADFS * @param {LoginBySamlRequestDto} loginBySamlRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ loginBySaml: (loginBySamlRequestDto: LoginBySamlRequestDto, options?: AxiosRequestConfig) => Promise; /** * Sign tenant user out. * @summary Logout tenant * @param {LogoutRequestDto} logoutRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ logout: (logoutRequestDto: LogoutRequestDto, options?: AxiosRequestConfig) => Promise; /** * Get new access token, new refresh token. * @summary Refresh token by tenant * @param {RefreshTokenDto} refreshTokenDto * @param {string} [cookie] HTTP only cookie that was sent during login * @param {*} [options] Override http request option. * @throws {RequiredError} */ refreshToken: (refreshTokenDto: RefreshTokenDto, cookie?: string, options?: AxiosRequestConfig) => Promise; /** * Change tenant user\'s password using the token provided by the reset password endpoint. * @summary Change password by tenant * @param {ResetPasswordRequestDto} resetPasswordRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetPassword: (resetPasswordRequestDto: ResetPasswordRequestDto, options?: AxiosRequestConfig) => Promise; /** * Verify the invite sent to the tenant user via email. * @summary Verify tenant user\'s invite token * @param {string} token * @param {*} [options] Override http request option. * @throws {RequiredError} */ verifyInvite: (token: string, options?: AxiosRequestConfig) => Promise; /** * Verifies token and returns necessary data for signing up as an organization. * @summary Verify a organization\'s invitation token * @param {string} invitationToken * @param {*} [options] Override http request option. * @throws {RequiredError} */ verifyOrgInvitation: (invitationToken: string, options?: AxiosRequestConfig) => Promise; /** * Verify the reset password token that is sent by calling the \'forgot password\' endpoint. * @summary Verify tenant reset password token * @param {string} resetToken Tenant user\'s reset token. Reset token can be found in the email sent after \'forgot-password\' endpoint was called. * @param {*} [options] Override http request option. * @throws {RequiredError} */ verifyResetPasswordToken: (resetToken: string, options?: AxiosRequestConfig) => Promise; }; /** * AuthserviceApi - functional programming interface * @export */ export declare const AuthserviceApiFp: (configuration?: Configuration) => { /** * Register a new organization with appropriate hierarchy and create a user for that organization. * @summary Register Organization and User using invitation token * @param {CreateOrgAndUserRequestDto} createOrgAndUserRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrgAndUser(createOrgAndUserRequestDto: CreateOrgAndUserRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Register a tenant user using the invite token sent to the tenant user\'s email address. * @summary Register tenant user after invite * @param {CreateUserRequestDto} createUserRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUser(createUserRequestDto: CreateUserRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Send a tenant user a reset-password token via email. * @summary Forgot password by tenant * @param {ForgotPasswordRequestDto} forgotPasswordRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ forgotPassword(forgotPasswordRequestDto: ForgotPasswordRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get SAML login link configured for the tenant in cognito as well as tenant settings * @summary Get SAML login link for tenant * @param {string} tenantSlug * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSamlLoginLink(tenantSlug: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get new access token, refresh token after successful login. * @summary Login by tenant * @param {LoginRequestDto} loginRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ login(loginRequestDto: LoginRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get new access token, refresh token after successful login. This api also creates a tenant user if user does not exist * @summary Login by SAML idp provider such as ADFS * @param {LoginBySamlRequestDto} loginBySamlRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ loginBySaml(loginBySamlRequestDto: LoginBySamlRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sign tenant user out. * @summary Logout tenant * @param {LogoutRequestDto} logoutRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ logout(logoutRequestDto: LogoutRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get new access token, new refresh token. * @summary Refresh token by tenant * @param {RefreshTokenDto} refreshTokenDto * @param {string} [cookie] HTTP only cookie that was sent during login * @param {*} [options] Override http request option. * @throws {RequiredError} */ refreshToken(refreshTokenDto: RefreshTokenDto, cookie?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Change tenant user\'s password using the token provided by the reset password endpoint. * @summary Change password by tenant * @param {ResetPasswordRequestDto} resetPasswordRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetPassword(resetPasswordRequestDto: ResetPasswordRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Verify the invite sent to the tenant user via email. * @summary Verify tenant user\'s invite token * @param {string} token * @param {*} [options] Override http request option. * @throws {RequiredError} */ verifyInvite(token: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Verifies token and returns necessary data for signing up as an organization. * @summary Verify a organization\'s invitation token * @param {string} invitationToken * @param {*} [options] Override http request option. * @throws {RequiredError} */ verifyOrgInvitation(invitationToken: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Verify the reset password token that is sent by calling the \'forgot password\' endpoint. * @summary Verify tenant reset password token * @param {string} resetToken Tenant user\'s reset token. Reset token can be found in the email sent after \'forgot-password\' endpoint was called. * @param {*} [options] Override http request option. * @throws {RequiredError} */ verifyResetPasswordToken(resetToken: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AuthserviceApi - factory interface * @export */ export declare const AuthserviceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Register a new organization with appropriate hierarchy and create a user for that organization. * @summary Register Organization and User using invitation token * @param {CreateOrgAndUserRequestDto} createOrgAndUserRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrgAndUser(createOrgAndUserRequestDto: CreateOrgAndUserRequestDto, options?: any): AxiosPromise; /** * Register a tenant user using the invite token sent to the tenant user\'s email address. * @summary Register tenant user after invite * @param {CreateUserRequestDto} createUserRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUser(createUserRequestDto: CreateUserRequestDto, options?: any): AxiosPromise; /** * Send a tenant user a reset-password token via email. * @summary Forgot password by tenant * @param {ForgotPasswordRequestDto} forgotPasswordRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ forgotPassword(forgotPasswordRequestDto: ForgotPasswordRequestDto, options?: any): AxiosPromise; /** * Get SAML login link configured for the tenant in cognito as well as tenant settings * @summary Get SAML login link for tenant * @param {string} tenantSlug * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSamlLoginLink(tenantSlug: string, options?: any): AxiosPromise; /** * Get new access token, refresh token after successful login. * @summary Login by tenant * @param {LoginRequestDto} loginRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ login(loginRequestDto: LoginRequestDto, options?: any): AxiosPromise; /** * Get new access token, refresh token after successful login. This api also creates a tenant user if user does not exist * @summary Login by SAML idp provider such as ADFS * @param {LoginBySamlRequestDto} loginBySamlRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ loginBySaml(loginBySamlRequestDto: LoginBySamlRequestDto, options?: any): AxiosPromise; /** * Sign tenant user out. * @summary Logout tenant * @param {LogoutRequestDto} logoutRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ logout(logoutRequestDto: LogoutRequestDto, options?: any): AxiosPromise; /** * Get new access token, new refresh token. * @summary Refresh token by tenant * @param {RefreshTokenDto} refreshTokenDto * @param {string} [cookie] HTTP only cookie that was sent during login * @param {*} [options] Override http request option. * @throws {RequiredError} */ refreshToken(refreshTokenDto: RefreshTokenDto, cookie?: string, options?: any): AxiosPromise; /** * Change tenant user\'s password using the token provided by the reset password endpoint. * @summary Change password by tenant * @param {ResetPasswordRequestDto} resetPasswordRequestDto * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetPassword(resetPasswordRequestDto: ResetPasswordRequestDto, options?: any): AxiosPromise; /** * Verify the invite sent to the tenant user via email. * @summary Verify tenant user\'s invite token * @param {string} token * @param {*} [options] Override http request option. * @throws {RequiredError} */ verifyInvite(token: string, options?: any): AxiosPromise; /** * Verifies token and returns necessary data for signing up as an organization. * @summary Verify a organization\'s invitation token * @param {string} invitationToken * @param {*} [options] Override http request option. * @throws {RequiredError} */ verifyOrgInvitation(invitationToken: string, options?: any): AxiosPromise; /** * Verify the reset password token that is sent by calling the \'forgot password\' endpoint. * @summary Verify tenant reset password token * @param {string} resetToken Tenant user\'s reset token. Reset token can be found in the email sent after \'forgot-password\' endpoint was called. * @param {*} [options] Override http request option. * @throws {RequiredError} */ verifyResetPasswordToken(resetToken: string, options?: any): AxiosPromise; }; /** * Request parameters for createOrgAndUser operation in AuthserviceApi. * @export * @interface AuthserviceApiCreateOrgAndUserRequest */ export interface AuthserviceApiCreateOrgAndUserRequest { /** * * @type {CreateOrgAndUserRequestDto} * @memberof AuthserviceApiCreateOrgAndUser */ readonly createOrgAndUserRequestDto: CreateOrgAndUserRequestDto; } /** * Request parameters for createUser operation in AuthserviceApi. * @export * @interface AuthserviceApiCreateUserRequest */ export interface AuthserviceApiCreateUserRequest { /** * * @type {CreateUserRequestDto} * @memberof AuthserviceApiCreateUser */ readonly createUserRequestDto: CreateUserRequestDto; } /** * Request parameters for forgotPassword operation in AuthserviceApi. * @export * @interface AuthserviceApiForgotPasswordRequest */ export interface AuthserviceApiForgotPasswordRequest { /** * * @type {ForgotPasswordRequestDto} * @memberof AuthserviceApiForgotPassword */ readonly forgotPasswordRequestDto: ForgotPasswordRequestDto; } /** * Request parameters for getSamlLoginLink operation in AuthserviceApi. * @export * @interface AuthserviceApiGetSamlLoginLinkRequest */ export interface AuthserviceApiGetSamlLoginLinkRequest { /** * * @type {string} * @memberof AuthserviceApiGetSamlLoginLink */ readonly tenantSlug: string; } /** * Request parameters for login operation in AuthserviceApi. * @export * @interface AuthserviceApiLoginRequest */ export interface AuthserviceApiLoginRequest { /** * * @type {LoginRequestDto} * @memberof AuthserviceApiLogin */ readonly loginRequestDto: LoginRequestDto; } /** * Request parameters for loginBySaml operation in AuthserviceApi. * @export * @interface AuthserviceApiLoginBySamlRequest */ export interface AuthserviceApiLoginBySamlRequest { /** * * @type {LoginBySamlRequestDto} * @memberof AuthserviceApiLoginBySaml */ readonly loginBySamlRequestDto: LoginBySamlRequestDto; } /** * Request parameters for logout operation in AuthserviceApi. * @export * @interface AuthserviceApiLogoutRequest */ export interface AuthserviceApiLogoutRequest { /** * * @type {LogoutRequestDto} * @memberof AuthserviceApiLogout */ readonly logoutRequestDto: LogoutRequestDto; } /** * Request parameters for refreshToken operation in AuthserviceApi. * @export * @interface AuthserviceApiRefreshTokenRequest */ export interface AuthserviceApiRefreshTokenRequest { /** * * @type {RefreshTokenDto} * @memberof AuthserviceApiRefreshToken */ readonly refreshTokenDto: RefreshTokenDto; /** * HTTP only cookie that was sent during login * @type {string} * @memberof AuthserviceApiRefreshToken */ readonly cookie?: string; } /** * Request parameters for resetPassword operation in AuthserviceApi. * @export * @interface AuthserviceApiResetPasswordRequest */ export interface AuthserviceApiResetPasswordRequest { /** * * @type {ResetPasswordRequestDto} * @memberof AuthserviceApiResetPassword */ readonly resetPasswordRequestDto: ResetPasswordRequestDto; } /** * Request parameters for verifyInvite operation in AuthserviceApi. * @export * @interface AuthserviceApiVerifyInviteRequest */ export interface AuthserviceApiVerifyInviteRequest { /** * * @type {string} * @memberof AuthserviceApiVerifyInvite */ readonly token: string; } /** * Request parameters for verifyOrgInvitation operation in AuthserviceApi. * @export * @interface AuthserviceApiVerifyOrgInvitationRequest */ export interface AuthserviceApiVerifyOrgInvitationRequest { /** * * @type {string} * @memberof AuthserviceApiVerifyOrgInvitation */ readonly invitationToken: string; } /** * Request parameters for verifyResetPasswordToken operation in AuthserviceApi. * @export * @interface AuthserviceApiVerifyResetPasswordTokenRequest */ export interface AuthserviceApiVerifyResetPasswordTokenRequest { /** * Tenant user\'s reset token. Reset token can be found in the email sent after \'forgot-password\' endpoint was called. * @type {string} * @memberof AuthserviceApiVerifyResetPasswordToken */ readonly resetToken: string; } /** * AuthserviceApi - object-oriented interface * @export * @class AuthserviceApi * @extends {BaseAPI} */ export declare class AuthserviceApi extends BaseAPI { /** * Register a new organization with appropriate hierarchy and create a user for that organization. * @summary Register Organization and User using invitation token * @param {AuthserviceApiCreateOrgAndUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthserviceApi */ createOrgAndUser(requestParameters: AuthserviceApiCreateOrgAndUserRequest, options?: AxiosRequestConfig): Promise>; /** * Register a tenant user using the invite token sent to the tenant user\'s email address. * @summary Register tenant user after invite * @param {AuthserviceApiCreateUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthserviceApi */ createUser(requestParameters: AuthserviceApiCreateUserRequest, options?: AxiosRequestConfig): Promise>; /** * Send a tenant user a reset-password token via email. * @summary Forgot password by tenant * @param {AuthserviceApiForgotPasswordRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthserviceApi */ forgotPassword(requestParameters: AuthserviceApiForgotPasswordRequest, options?: AxiosRequestConfig): Promise>; /** * Get SAML login link configured for the tenant in cognito as well as tenant settings * @summary Get SAML login link for tenant * @param {AuthserviceApiGetSamlLoginLinkRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthserviceApi */ getSamlLoginLink(requestParameters: AuthserviceApiGetSamlLoginLinkRequest, options?: AxiosRequestConfig): Promise>; /** * Get new access token, refresh token after successful login. * @summary Login by tenant * @param {AuthserviceApiLoginRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthserviceApi */ login(requestParameters: AuthserviceApiLoginRequest, options?: AxiosRequestConfig): Promise>; /** * Get new access token, refresh token after successful login. This api also creates a tenant user if user does not exist * @summary Login by SAML idp provider such as ADFS * @param {AuthserviceApiLoginBySamlRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthserviceApi */ loginBySaml(requestParameters: AuthserviceApiLoginBySamlRequest, options?: AxiosRequestConfig): Promise>; /** * Sign tenant user out. * @summary Logout tenant * @param {AuthserviceApiLogoutRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthserviceApi */ logout(requestParameters: AuthserviceApiLogoutRequest, options?: AxiosRequestConfig): Promise>; /** * Get new access token, new refresh token. * @summary Refresh token by tenant * @param {AuthserviceApiRefreshTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthserviceApi */ refreshToken(requestParameters: AuthserviceApiRefreshTokenRequest, options?: AxiosRequestConfig): Promise>; /** * Change tenant user\'s password using the token provided by the reset password endpoint. * @summary Change password by tenant * @param {AuthserviceApiResetPasswordRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthserviceApi */ resetPassword(requestParameters: AuthserviceApiResetPasswordRequest, options?: AxiosRequestConfig): Promise>; /** * Verify the invite sent to the tenant user via email. * @summary Verify tenant user\'s invite token * @param {AuthserviceApiVerifyInviteRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthserviceApi */ verifyInvite(requestParameters: AuthserviceApiVerifyInviteRequest, options?: AxiosRequestConfig): Promise>; /** * Verifies token and returns necessary data for signing up as an organization. * @summary Verify a organization\'s invitation token * @param {AuthserviceApiVerifyOrgInvitationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthserviceApi */ verifyOrgInvitation(requestParameters: AuthserviceApiVerifyOrgInvitationRequest, options?: AxiosRequestConfig): Promise>; /** * Verify the reset password token that is sent by calling the \'forgot password\' endpoint. * @summary Verify tenant reset password token * @param {AuthserviceApiVerifyResetPasswordTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthserviceApi */ verifyResetPasswordToken(requestParameters: AuthserviceApiVerifyResetPasswordTokenRequest, options?: AxiosRequestConfig): Promise>; }