/** * Identity Security Cloud API - MFA Configuration * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * * @export * @interface GetMFAOktaConfigV1401Response */ export interface GetMFAOktaConfigV1401Response { /** * A message describing the error * @type {any} * @memberof GetMFAOktaConfigV1401Response */ 'error'?: any; } /** * * @export * @interface GetMFAOktaConfigV1429Response */ export interface GetMFAOktaConfigV1429Response { /** * A message describing the error * @type {any} * @memberof GetMFAOktaConfigV1429Response */ 'message'?: any; } /** * * @export * @interface KbaAnswerRequestItem */ export interface KbaAnswerRequestItem { /** * Question Id * @type {string} * @memberof KbaAnswerRequestItem */ 'id': string; /** * An answer for the KBA question * @type {string} * @memberof KbaAnswerRequestItem */ 'answer': string; } /** * * @export * @interface KbaAnswerResponseItem */ export interface KbaAnswerResponseItem { /** * Question Id * @type {string} * @memberof KbaAnswerResponseItem */ 'id': string; /** * Question description * @type {string} * @memberof KbaAnswerResponseItem */ 'question': string; /** * Denotes whether the KBA question has an answer configured for the current user * @type {boolean} * @memberof KbaAnswerResponseItem */ 'hasAnswer': boolean; } /** * KBA Configuration * @export * @interface KbaQuestion */ export interface KbaQuestion { /** * KBA Question Id * @type {string} * @memberof KbaQuestion */ 'id': string; /** * KBA Question description * @type {string} * @memberof KbaQuestion */ 'text': string; /** * Denotes whether the KBA question has an answer configured for any user in the tenant * @type {boolean} * @memberof KbaQuestion */ 'hasAnswer': boolean; /** * Denotes the number of KBA configurations for this question * @type {number} * @memberof KbaQuestion */ 'numAnswers': number; } /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const LocaleOrigin: { readonly Default: "DEFAULT"; readonly Request: "REQUEST"; }; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * Response model for configuration test of a given MFA method * @export * @interface MfaConfigTestResponse */ export interface MfaConfigTestResponse { /** * The configuration test result. * @type {string} * @memberof MfaConfigTestResponse */ 'state'?: MfaConfigTestResponseStateEnum; /** * The error message to indicate the failure of configuration test. * @type {string} * @memberof MfaConfigTestResponse */ 'error'?: string; } export declare const MfaConfigTestResponseStateEnum: { readonly Success: "SUCCESS"; readonly Failed: "FAILED"; }; export type MfaConfigTestResponseStateEnum = typeof MfaConfigTestResponseStateEnum[keyof typeof MfaConfigTestResponseStateEnum]; /** * * @export * @interface MfaDuoConfig */ export interface MfaDuoConfig { /** * Mfa method name * @type {string} * @memberof MfaDuoConfig */ 'mfaMethod'?: string | null; /** * If MFA method is enabled. * @type {boolean} * @memberof MfaDuoConfig */ 'enabled'?: boolean; /** * The server host name or IP address of the MFA provider. * @type {string} * @memberof MfaDuoConfig */ 'host'?: string | null; /** * The secret key for authenticating requests to the MFA provider. * @type {string} * @memberof MfaDuoConfig */ 'accessKey'?: string | null; /** * Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. * @type {string} * @memberof MfaDuoConfig */ 'identityAttribute'?: string | null; /** * A map with additional config properties for the given MFA method - duo-web. * @type {{ [key: string]: any; }} * @memberof MfaDuoConfig */ 'configProperties'?: { [key: string]: any; } | null; } /** * * @export * @interface MfaOktaConfig */ export interface MfaOktaConfig { /** * Mfa method name * @type {string} * @memberof MfaOktaConfig */ 'mfaMethod'?: string | null; /** * If MFA method is enabled. * @type {boolean} * @memberof MfaOktaConfig */ 'enabled'?: boolean; /** * The server host name or IP address of the MFA provider. * @type {string} * @memberof MfaOktaConfig */ 'host'?: string | null; /** * The secret key for authenticating requests to the MFA provider. * @type {string} * @memberof MfaOktaConfig */ 'accessKey'?: string | null; /** * Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. * @type {string} * @memberof MfaOktaConfig */ 'identityAttribute'?: string | null; } /** * MFAConfigurationApi - axios parameter creator * @export */ export declare const MFAConfigurationApiAxiosParamCreator: (configuration?: Configuration) => { /** * This API returns the configuration of an Duo MFA method. * @summary Configuration of duo mfa method * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMFADuoConfigV1: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API returns the KBA configuration for MFA. * @summary Configuration of kba mfa method * @param {boolean} [allLanguages] Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMFAKbaConfigV1: (allLanguages?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API returns the configuration of an Okta MFA method. * @summary Configuration of okta mfa method * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMFAOktaConfigV1: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API sets the configuration of an Duo MFA method. * @summary Set duo mfa configuration * @param {MfaDuoConfig} mfaDuoConfig * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setMFADuoConfigV1: (mfaDuoConfig: MfaDuoConfig, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. * @summary Set mfa kba configuration * @param {Array} kbaAnswerRequestItem * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setMFAKBAConfigV1: (kbaAnswerRequestItem: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API sets the configuration of an Okta MFA method. * @summary Set okta mfa configuration * @param {MfaOktaConfig} mfaOktaConfig * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setMFAOktaConfigV1: (mfaOktaConfig: MfaOktaConfig, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. * @summary Mfa method\'s test configuration * @param {TestMFAConfigV1MethodEnum} method The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testMFAConfigV1: (method: TestMFAConfigV1MethodEnum, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * MFAConfigurationApi - functional programming interface * @export */ export declare const MFAConfigurationApiFp: (configuration?: Configuration) => { /** * This API returns the configuration of an Duo MFA method. * @summary Configuration of duo mfa method * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMFADuoConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API returns the KBA configuration for MFA. * @summary Configuration of kba mfa method * @param {boolean} [allLanguages] Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMFAKbaConfigV1(allLanguages?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This API returns the configuration of an Okta MFA method. * @summary Configuration of okta mfa method * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMFAOktaConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API sets the configuration of an Duo MFA method. * @summary Set duo mfa configuration * @param {MfaDuoConfig} mfaDuoConfig * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setMFADuoConfigV1(mfaDuoConfig: MfaDuoConfig, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. * @summary Set mfa kba configuration * @param {Array} kbaAnswerRequestItem * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setMFAKBAConfigV1(kbaAnswerRequestItem: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This API sets the configuration of an Okta MFA method. * @summary Set okta mfa configuration * @param {MfaOktaConfig} mfaOktaConfig * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setMFAOktaConfigV1(mfaOktaConfig: MfaOktaConfig, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. * @summary Mfa method\'s test configuration * @param {TestMFAConfigV1MethodEnum} method The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testMFAConfigV1(method: TestMFAConfigV1MethodEnum, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MFAConfigurationApi - factory interface * @export */ export declare const MFAConfigurationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This API returns the configuration of an Duo MFA method. * @summary Configuration of duo mfa method * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMFADuoConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API returns the KBA configuration for MFA. * @summary Configuration of kba mfa method * @param {MFAConfigurationApiGetMFAKbaConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMFAKbaConfigV1(requestParameters?: MFAConfigurationApiGetMFAKbaConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This API returns the configuration of an Okta MFA method. * @summary Configuration of okta mfa method * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMFAOktaConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API sets the configuration of an Duo MFA method. * @summary Set duo mfa configuration * @param {MFAConfigurationApiSetMFADuoConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setMFADuoConfigV1(requestParameters: MFAConfigurationApiSetMFADuoConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. * @summary Set mfa kba configuration * @param {MFAConfigurationApiSetMFAKBAConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setMFAKBAConfigV1(requestParameters: MFAConfigurationApiSetMFAKBAConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This API sets the configuration of an Okta MFA method. * @summary Set okta mfa configuration * @param {MFAConfigurationApiSetMFAOktaConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setMFAOktaConfigV1(requestParameters: MFAConfigurationApiSetMFAOktaConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. * @summary Mfa method\'s test configuration * @param {MFAConfigurationApiTestMFAConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testMFAConfigV1(requestParameters: MFAConfigurationApiTestMFAConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getMFAKbaConfigV1 operation in MFAConfigurationApi. * @export * @interface MFAConfigurationApiGetMFAKbaConfigV1Request */ export interface MFAConfigurationApiGetMFAKbaConfigV1Request { /** * Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false * @type {boolean} * @memberof MFAConfigurationApiGetMFAKbaConfigV1 */ readonly allLanguages?: boolean; } /** * Request parameters for setMFADuoConfigV1 operation in MFAConfigurationApi. * @export * @interface MFAConfigurationApiSetMFADuoConfigV1Request */ export interface MFAConfigurationApiSetMFADuoConfigV1Request { /** * * @type {MfaDuoConfig} * @memberof MFAConfigurationApiSetMFADuoConfigV1 */ readonly mfaDuoConfig: MfaDuoConfig; } /** * Request parameters for setMFAKBAConfigV1 operation in MFAConfigurationApi. * @export * @interface MFAConfigurationApiSetMFAKBAConfigV1Request */ export interface MFAConfigurationApiSetMFAKBAConfigV1Request { /** * * @type {Array} * @memberof MFAConfigurationApiSetMFAKBAConfigV1 */ readonly kbaAnswerRequestItem: Array; } /** * Request parameters for setMFAOktaConfigV1 operation in MFAConfigurationApi. * @export * @interface MFAConfigurationApiSetMFAOktaConfigV1Request */ export interface MFAConfigurationApiSetMFAOktaConfigV1Request { /** * * @type {MfaOktaConfig} * @memberof MFAConfigurationApiSetMFAOktaConfigV1 */ readonly mfaOktaConfig: MfaOktaConfig; } /** * Request parameters for testMFAConfigV1 operation in MFAConfigurationApi. * @export * @interface MFAConfigurationApiTestMFAConfigV1Request */ export interface MFAConfigurationApiTestMFAConfigV1Request { /** * The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. * @type {'okta-verify' | 'duo-web'} * @memberof MFAConfigurationApiTestMFAConfigV1 */ readonly method: TestMFAConfigV1MethodEnum; } /** * MFAConfigurationApi - object-oriented interface * @export * @class MFAConfigurationApi * @extends {BaseAPI} */ export declare class MFAConfigurationApi extends BaseAPI { /** * This API returns the configuration of an Duo MFA method. * @summary Configuration of duo mfa method * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MFAConfigurationApi */ getMFADuoConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API returns the KBA configuration for MFA. * @summary Configuration of kba mfa method * @param {MFAConfigurationApiGetMFAKbaConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MFAConfigurationApi */ getMFAKbaConfigV1(requestParameters?: MFAConfigurationApiGetMFAKbaConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API returns the configuration of an Okta MFA method. * @summary Configuration of okta mfa method * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MFAConfigurationApi */ getMFAOktaConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API sets the configuration of an Duo MFA method. * @summary Set duo mfa configuration * @param {MFAConfigurationApiSetMFADuoConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MFAConfigurationApi */ setMFADuoConfigV1(requestParameters: MFAConfigurationApiSetMFADuoConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. * @summary Set mfa kba configuration * @param {MFAConfigurationApiSetMFAKBAConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MFAConfigurationApi */ setMFAKBAConfigV1(requestParameters: MFAConfigurationApiSetMFAKBAConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API sets the configuration of an Okta MFA method. * @summary Set okta mfa configuration * @param {MFAConfigurationApiSetMFAOktaConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MFAConfigurationApi */ setMFAOktaConfigV1(requestParameters: MFAConfigurationApiSetMFAOktaConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. * @summary Mfa method\'s test configuration * @param {MFAConfigurationApiTestMFAConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MFAConfigurationApi */ testMFAConfigV1(requestParameters: MFAConfigurationApiTestMFAConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const TestMFAConfigV1MethodEnum: { readonly OktaVerify: "okta-verify"; readonly DuoWeb: "duo-web"; }; export type TestMFAConfigV1MethodEnum = typeof TestMFAConfigV1MethodEnum[keyof typeof TestMFAConfigV1MethodEnum];