/** * Identity Security Cloud API - Auth Profile * 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 ArrayInner */ export interface ArrayInner { } /** * * @export * @interface AuthProfile */ export interface AuthProfile { /** * Authentication Profile name. * @type {string} * @memberof AuthProfile */ 'name'?: string; /** * Use it to block access from off network. * @type {boolean} * @memberof AuthProfile */ 'offNetwork'?: boolean; /** * Use it to block access from untrusted geoographies. * @type {boolean} * @memberof AuthProfile */ 'untrustedGeography'?: boolean; /** * Application ID. * @type {string} * @memberof AuthProfile */ 'applicationId'?: string | null; /** * Application name. * @type {string} * @memberof AuthProfile */ 'applicationName'?: string | null; /** * Type of the Authentication Profile. * @type {string} * @memberof AuthProfile */ 'type'?: AuthProfileTypeEnum; /** * Use it to enable strong authentication. * @type {boolean} * @memberof AuthProfile */ 'strongAuthLogin'?: boolean; } export declare const AuthProfileTypeEnum: { readonly Block: "BLOCK"; readonly Mfa: "MFA"; readonly NonPta: "NON_PTA"; readonly Pta: "PTA"; }; export type AuthProfileTypeEnum = typeof AuthProfileTypeEnum[keyof typeof AuthProfileTypeEnum]; /** * * @export * @interface AuthProfileSummary */ export interface AuthProfileSummary { /** * Tenant name. * @type {string} * @memberof AuthProfileSummary */ 'tenant'?: string; /** * Identity ID. * @type {string} * @memberof AuthProfileSummary */ 'id'?: string; } /** * * @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 GetProfileConfigListV1401Response */ export interface GetProfileConfigListV1401Response { /** * A message describing the error * @type {any} * @memberof GetProfileConfigListV1401Response */ 'error'?: any; } /** * * @export * @interface GetProfileConfigListV1429Response */ export interface GetProfileConfigListV1429Response { /** * A message describing the error * @type {any} * @memberof GetProfileConfigListV1429Response */ 'message'?: any; } /** * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface JsonPatchOperation */ export interface JsonPatchOperation { /** * The operation to be performed * @type {string} * @memberof JsonPatchOperation */ 'op': JsonPatchOperationOpEnum; /** * A string JSON Pointer representing the target path to an element to be affected by the operation * @type {string} * @memberof JsonPatchOperation */ 'path': string; /** * * @type {JsonPatchOperationValue} * @memberof JsonPatchOperation */ 'value'?: JsonPatchOperationValue; } export declare const JsonPatchOperationOpEnum: { readonly Add: "add"; readonly Remove: "remove"; readonly Replace: "replace"; readonly Move: "move"; readonly Copy: "copy"; readonly Test: "test"; }; export type JsonPatchOperationOpEnum = typeof JsonPatchOperationOpEnum[keyof typeof JsonPatchOperationOpEnum]; /** * @type JsonPatchOperationValue * The value to be used for the operation, required for \"add\" and \"replace\" operations * @export */ export type JsonPatchOperationValue = Array | boolean | number | object | string; /** * 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]; /** * AuthProfileApi - axios parameter creator * @export */ export declare const AuthProfileApiAxiosParamCreator: (configuration?: Configuration) => { /** * This API returns a list of auth profiles. * @summary Get list of auth profiles * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileConfigListV1: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API returns auth profile information. * @summary Get auth profile * @param {string} id ID of the Auth Profile to patch. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileConfigV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** * @summary Patch a specified auth profile * @param {string} id ID of the Auth Profile to patch. * @param {Array} jsonPatchOperation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchProfileConfigV1: (id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * AuthProfileApi - functional programming interface * @export */ export declare const AuthProfileApiFp: (configuration?: Configuration) => { /** * This API returns a list of auth profiles. * @summary Get list of auth profiles * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileConfigListV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This API returns auth profile information. * @summary Get auth profile * @param {string} id ID of the Auth Profile to patch. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileConfigV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** * @summary Patch a specified auth profile * @param {string} id ID of the Auth Profile to patch. * @param {Array} jsonPatchOperation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchProfileConfigV1(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AuthProfileApi - factory interface * @export */ export declare const AuthProfileApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This API returns a list of auth profiles. * @summary Get list of auth profiles * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileConfigListV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This API returns auth profile information. * @summary Get auth profile * @param {AuthProfileApiGetProfileConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileConfigV1(requestParameters: AuthProfileApiGetProfileConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** * @summary Patch a specified auth profile * @param {AuthProfileApiPatchProfileConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchProfileConfigV1(requestParameters: AuthProfileApiPatchProfileConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getProfileConfigV1 operation in AuthProfileApi. * @export * @interface AuthProfileApiGetProfileConfigV1Request */ export interface AuthProfileApiGetProfileConfigV1Request { /** * ID of the Auth Profile to patch. * @type {string} * @memberof AuthProfileApiGetProfileConfigV1 */ readonly id: string; } /** * Request parameters for patchProfileConfigV1 operation in AuthProfileApi. * @export * @interface AuthProfileApiPatchProfileConfigV1Request */ export interface AuthProfileApiPatchProfileConfigV1Request { /** * ID of the Auth Profile to patch. * @type {string} * @memberof AuthProfileApiPatchProfileConfigV1 */ readonly id: string; /** * * @type {Array} * @memberof AuthProfileApiPatchProfileConfigV1 */ readonly jsonPatchOperation: Array; } /** * AuthProfileApi - object-oriented interface * @export * @class AuthProfileApi * @extends {BaseAPI} */ export declare class AuthProfileApi extends BaseAPI { /** * This API returns a list of auth profiles. * @summary Get list of auth profiles * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AuthProfileApi */ getProfileConfigListV1(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API returns auth profile information. * @summary Get auth profile * @param {AuthProfileApiGetProfileConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AuthProfileApi */ getProfileConfigV1(requestParameters: AuthProfileApiGetProfileConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** * @summary Patch a specified auth profile * @param {AuthProfileApiPatchProfileConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AuthProfileApi */ patchProfileConfigV1(requestParameters: AuthProfileApiPatchProfileConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }