/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Password Policies * 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 globalAxios from 'axios'; // 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'; import type { RequestArgs } from './base'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } 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 GetPasswordPolicyByIdV1401Response */ export interface GetPasswordPolicyByIdV1401Response { /** * A message describing the error * @type {any} * @memberof GetPasswordPolicyByIdV1401Response */ 'error'?: any; } /** * * @export * @interface GetPasswordPolicyByIdV1429Response */ export interface GetPasswordPolicyByIdV1429Response { /** * A message describing the error * @type {any} * @memberof GetPasswordPolicyByIdV1429Response */ 'message'?: any; } /** * 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 const LocaleOrigin = { Default: 'DEFAULT', Request: 'REQUEST' } as const; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * * @export * @interface PasswordPolicyV3Dto */ export interface PasswordPolicyV3Dto { /** * The password policy Id. * @type {string} * @memberof PasswordPolicyV3Dto */ 'id'?: string; /** * Description for current password policy. * @type {string} * @memberof PasswordPolicyV3Dto */ 'description'?: string | null; /** * The name of the password policy. * @type {string} * @memberof PasswordPolicyV3Dto */ 'name'?: string; /** * Date the Password Policy was created. * @type {number} * @memberof PasswordPolicyV3Dto */ 'dateCreated'?: number; /** * Date the Password Policy was updated. * @type {number} * @memberof PasswordPolicyV3Dto */ 'lastUpdated'?: number | null; /** * The number of days before expiration remaninder. * @type {number} * @memberof PasswordPolicyV3Dto */ 'firstExpirationReminder'?: number; /** * The minimun length of account Id. By default is equals to -1. * @type {number} * @memberof PasswordPolicyV3Dto */ 'accountIdMinWordLength'?: number; /** * The minimun length of account name. By default is equals to -1. * @type {number} * @memberof PasswordPolicyV3Dto */ 'accountNameMinWordLength'?: number; /** * Maximum alpha. By default is equals to 0. * @type {number} * @memberof PasswordPolicyV3Dto */ 'minAlpha'?: number; /** * MinCharacterTypes. By default is equals to -1. * @type {number} * @memberof PasswordPolicyV3Dto */ 'minCharacterTypes'?: number; /** * Maximum length of the password. * @type {number} * @memberof PasswordPolicyV3Dto */ 'maxLength'?: number; /** * Minimum length of the password. By default is equals to 0. * @type {number} * @memberof PasswordPolicyV3Dto */ 'minLength'?: number; /** * Maximum repetition of the same character in the password. By default is equals to -1. * @type {number} * @memberof PasswordPolicyV3Dto */ 'maxRepeatedChars'?: number; /** * Minimum amount of lower case character in the password. By default is equals to 0. * @type {number} * @memberof PasswordPolicyV3Dto */ 'minLower'?: number; /** * Minimum amount of numeric characters in the password. By default is equals to 0. * @type {number} * @memberof PasswordPolicyV3Dto */ 'minNumeric'?: number; /** * Minimum amount of special symbols in the password. By default is equals to 0. * @type {number} * @memberof PasswordPolicyV3Dto */ 'minSpecial'?: number; /** * Minimum amount of upper case symbols in the password. By default is equals to 0. * @type {number} * @memberof PasswordPolicyV3Dto */ 'minUpper'?: number; /** * Number of days before current password expires. By default is equals to 90. * @type {number} * @memberof PasswordPolicyV3Dto */ 'passwordExpiration'?: number; /** * Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. * @type {boolean} * @memberof PasswordPolicyV3Dto */ 'defaultPolicy'?: boolean; /** * Defines whether this policy is enabled to expire or not. This field is false by default. * @type {boolean} * @memberof PasswordPolicyV3Dto */ 'enablePasswdExpiration'?: boolean; /** * Defines whether this policy require strong Auth or not. This field is false by default. * @type {boolean} * @memberof PasswordPolicyV3Dto */ 'requireStrongAuthn'?: boolean; /** * Defines whether this policy require strong Auth of network or not. This field is false by default. * @type {boolean} * @memberof PasswordPolicyV3Dto */ 'requireStrongAuthOffNetwork'?: boolean; /** * Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. * @type {boolean} * @memberof PasswordPolicyV3Dto */ 'requireStrongAuthUntrustedGeographies'?: boolean; /** * Defines whether this policy uses account attributes or not. This field is false by default. * @type {boolean} * @memberof PasswordPolicyV3Dto */ 'useAccountAttributes'?: boolean; /** * Defines whether this policy uses dictionary or not. This field is false by default. * @type {boolean} * @memberof PasswordPolicyV3Dto */ 'useDictionary'?: boolean; /** * Defines whether this policy uses identity attributes or not. This field is false by default. * @type {boolean} * @memberof PasswordPolicyV3Dto */ 'useIdentityAttributes'?: boolean; /** * Defines whether this policy validate against account id or not. This field is false by default. * @type {boolean} * @memberof PasswordPolicyV3Dto */ 'validateAgainstAccountId'?: boolean; /** * Defines whether this policy validate against account name or not. This field is false by default. * @type {boolean} * @memberof PasswordPolicyV3Dto */ 'validateAgainstAccountName'?: boolean; /** * * @type {string} * @memberof PasswordPolicyV3Dto */ 'created'?: string | null; /** * * @type {string} * @memberof PasswordPolicyV3Dto */ 'modified'?: string | null; /** * List of sources IDs managed by this password policy. * @type {Array} * @memberof PasswordPolicyV3Dto */ 'sourceIds'?: Array; } /** * PasswordPoliciesApi - axios parameter creator * @export */ export const PasswordPoliciesApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * This API creates the specified password policy. * @summary Create password policy * @param {PasswordPolicyV3Dto} passwordPolicyV3Dto * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPasswordPolicyV1: async (passwordPolicyV3Dto: PasswordPolicyV3Dto, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'passwordPolicyV3Dto' is not null or undefined assertParamExists('createPasswordPolicyV1', 'passwordPolicyV3Dto', passwordPolicyV3Dto) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/password-policies/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(passwordPolicyV3Dto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API deletes the specified password policy. * @summary Delete password policy by id * @param {string} id The ID of password policy to delete. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePasswordPolicyV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('deletePasswordPolicyV1', 'id', id) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/password-policies/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API returns the password policy for the specified ID. * @summary Get password policy by id * @param {string} id The ID of password policy to retrieve. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPasswordPolicyByIdV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getPasswordPolicyByIdV1', 'id', id) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/password-policies/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This gets list of all Password Policies. Requires role of ORG_ADMIN * @summary List password policies * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listPasswordPoliciesV1: async (limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/password-policies/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API updates the specified password policy. * @summary Update password policy by id * @param {string} id The ID of password policy to update. * @param {PasswordPolicyV3Dto} passwordPolicyV3Dto * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setPasswordPolicyV1: async (id: string, passwordPolicyV3Dto: PasswordPolicyV3Dto, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('setPasswordPolicyV1', 'id', id) // verify required parameter 'passwordPolicyV3Dto' is not null or undefined assertParamExists('setPasswordPolicyV1', 'passwordPolicyV3Dto', passwordPolicyV3Dto) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/password-policies/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(passwordPolicyV3Dto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * PasswordPoliciesApi - functional programming interface * @export */ export const PasswordPoliciesApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = PasswordPoliciesApiAxiosParamCreator(configuration) return { /** * This API creates the specified password policy. * @summary Create password policy * @param {PasswordPolicyV3Dto} passwordPolicyV3Dto * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createPasswordPolicyV1(passwordPolicyV3Dto: PasswordPolicyV3Dto, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordPolicyV1(passwordPolicyV3Dto, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesApi.createPasswordPolicyV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API deletes the specified password policy. * @summary Delete password policy by id * @param {string} id The ID of password policy to delete. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deletePasswordPolicyV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deletePasswordPolicyV1(id, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesApi.deletePasswordPolicyV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API returns the password policy for the specified ID. * @summary Get password policy by id * @param {string} id The ID of password policy to retrieve. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getPasswordPolicyByIdV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordPolicyByIdV1(id, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesApi.getPasswordPolicyByIdV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This gets list of all Password Policies. Requires role of ORG_ADMIN * @summary List password policies * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listPasswordPoliciesV1(limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listPasswordPoliciesV1(limit, offset, count, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesApi.listPasswordPoliciesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API updates the specified password policy. * @summary Update password policy by id * @param {string} id The ID of password policy to update. * @param {PasswordPolicyV3Dto} passwordPolicyV3Dto * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async setPasswordPolicyV1(id: string, passwordPolicyV3Dto: PasswordPolicyV3Dto, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.setPasswordPolicyV1(id, passwordPolicyV3Dto, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesApi.setPasswordPolicyV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * PasswordPoliciesApi - factory interface * @export */ export const PasswordPoliciesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = PasswordPoliciesApiFp(configuration) return { /** * This API creates the specified password policy. * @summary Create password policy * @param {PasswordPoliciesApiCreatePasswordPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPasswordPolicyV1(requestParameters: PasswordPoliciesApiCreatePasswordPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createPasswordPolicyV1(requestParameters.passwordPolicyV3Dto, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API deletes the specified password policy. * @summary Delete password policy by id * @param {PasswordPoliciesApiDeletePasswordPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePasswordPolicyV1(requestParameters: PasswordPoliciesApiDeletePasswordPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deletePasswordPolicyV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API returns the password policy for the specified ID. * @summary Get password policy by id * @param {PasswordPoliciesApiGetPasswordPolicyByIdV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPasswordPolicyByIdV1(requestParameters: PasswordPoliciesApiGetPasswordPolicyByIdV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getPasswordPolicyByIdV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This gets list of all Password Policies. Requires role of ORG_ADMIN * @summary List password policies * @param {PasswordPoliciesApiListPasswordPoliciesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listPasswordPoliciesV1(requestParameters: PasswordPoliciesApiListPasswordPoliciesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listPasswordPoliciesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API updates the specified password policy. * @summary Update password policy by id * @param {PasswordPoliciesApiSetPasswordPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setPasswordPolicyV1(requestParameters: PasswordPoliciesApiSetPasswordPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.setPasswordPolicyV1(requestParameters.id, requestParameters.passwordPolicyV3Dto, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for createPasswordPolicyV1 operation in PasswordPoliciesApi. * @export * @interface PasswordPoliciesApiCreatePasswordPolicyV1Request */ export interface PasswordPoliciesApiCreatePasswordPolicyV1Request { /** * * @type {PasswordPolicyV3Dto} * @memberof PasswordPoliciesApiCreatePasswordPolicyV1 */ readonly passwordPolicyV3Dto: PasswordPolicyV3Dto /** * Use this header to enable this experimental API. * @type {string} * @memberof PasswordPoliciesApiCreatePasswordPolicyV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for deletePasswordPolicyV1 operation in PasswordPoliciesApi. * @export * @interface PasswordPoliciesApiDeletePasswordPolicyV1Request */ export interface PasswordPoliciesApiDeletePasswordPolicyV1Request { /** * The ID of password policy to delete. * @type {string} * @memberof PasswordPoliciesApiDeletePasswordPolicyV1 */ readonly id: string /** * Use this header to enable this experimental API. * @type {string} * @memberof PasswordPoliciesApiDeletePasswordPolicyV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getPasswordPolicyByIdV1 operation in PasswordPoliciesApi. * @export * @interface PasswordPoliciesApiGetPasswordPolicyByIdV1Request */ export interface PasswordPoliciesApiGetPasswordPolicyByIdV1Request { /** * The ID of password policy to retrieve. * @type {string} * @memberof PasswordPoliciesApiGetPasswordPolicyByIdV1 */ readonly id: string /** * Use this header to enable this experimental API. * @type {string} * @memberof PasswordPoliciesApiGetPasswordPolicyByIdV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for listPasswordPoliciesV1 operation in PasswordPoliciesApi. * @export * @interface PasswordPoliciesApiListPasswordPoliciesV1Request */ export interface PasswordPoliciesApiListPasswordPoliciesV1Request { /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof PasswordPoliciesApiListPasswordPoliciesV1 */ readonly limit?: number /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof PasswordPoliciesApiListPasswordPoliciesV1 */ readonly offset?: number /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof PasswordPoliciesApiListPasswordPoliciesV1 */ readonly count?: boolean /** * Use this header to enable this experimental API. * @type {string} * @memberof PasswordPoliciesApiListPasswordPoliciesV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for setPasswordPolicyV1 operation in PasswordPoliciesApi. * @export * @interface PasswordPoliciesApiSetPasswordPolicyV1Request */ export interface PasswordPoliciesApiSetPasswordPolicyV1Request { /** * The ID of password policy to update. * @type {string} * @memberof PasswordPoliciesApiSetPasswordPolicyV1 */ readonly id: string /** * * @type {PasswordPolicyV3Dto} * @memberof PasswordPoliciesApiSetPasswordPolicyV1 */ readonly passwordPolicyV3Dto: PasswordPolicyV3Dto /** * Use this header to enable this experimental API. * @type {string} * @memberof PasswordPoliciesApiSetPasswordPolicyV1 */ readonly xSailPointExperimental?: string } /** * PasswordPoliciesApi - object-oriented interface * @export * @class PasswordPoliciesApi * @extends {BaseAPI} */ export class PasswordPoliciesApi extends BaseAPI { /** * This API creates the specified password policy. * @summary Create password policy * @param {PasswordPoliciesApiCreatePasswordPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PasswordPoliciesApi */ public createPasswordPolicyV1(requestParameters: PasswordPoliciesApiCreatePasswordPolicyV1Request, axiosOptions?: RawAxiosRequestConfig) { return PasswordPoliciesApiFp(this.configuration).createPasswordPolicyV1(requestParameters.passwordPolicyV3Dto, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API deletes the specified password policy. * @summary Delete password policy by id * @param {PasswordPoliciesApiDeletePasswordPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PasswordPoliciesApi */ public deletePasswordPolicyV1(requestParameters: PasswordPoliciesApiDeletePasswordPolicyV1Request, axiosOptions?: RawAxiosRequestConfig) { return PasswordPoliciesApiFp(this.configuration).deletePasswordPolicyV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API returns the password policy for the specified ID. * @summary Get password policy by id * @param {PasswordPoliciesApiGetPasswordPolicyByIdV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PasswordPoliciesApi */ public getPasswordPolicyByIdV1(requestParameters: PasswordPoliciesApiGetPasswordPolicyByIdV1Request, axiosOptions?: RawAxiosRequestConfig) { return PasswordPoliciesApiFp(this.configuration).getPasswordPolicyByIdV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This gets list of all Password Policies. Requires role of ORG_ADMIN * @summary List password policies * @param {PasswordPoliciesApiListPasswordPoliciesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PasswordPoliciesApi */ public listPasswordPoliciesV1(requestParameters: PasswordPoliciesApiListPasswordPoliciesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return PasswordPoliciesApiFp(this.configuration).listPasswordPoliciesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API updates the specified password policy. * @summary Update password policy by id * @param {PasswordPoliciesApiSetPasswordPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PasswordPoliciesApi */ public setPasswordPolicyV1(requestParameters: PasswordPoliciesApiSetPasswordPolicyV1Request, axiosOptions?: RawAxiosRequestConfig) { return PasswordPoliciesApiFp(this.configuration).setPasswordPolicyV1(requestParameters.id, requestParameters.passwordPolicyV3Dto, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } }