/** * Identity Security Cloud API - Password Sync Groups * 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 GetPasswordSyncGroupsV1401Response */ export interface GetPasswordSyncGroupsV1401Response { /** * A message describing the error * @type {any} * @memberof GetPasswordSyncGroupsV1401Response */ 'error'?: any; } /** * * @export * @interface GetPasswordSyncGroupsV1429Response */ export interface GetPasswordSyncGroupsV1429Response { /** * A message describing the error * @type {any} * @memberof GetPasswordSyncGroupsV1429Response */ '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 declare const LocaleOrigin: { readonly Default: "DEFAULT"; readonly Request: "REQUEST"; }; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * * @export * @interface PasswordSyncGroup */ export interface PasswordSyncGroup { /** * ID of the sync group * @type {string} * @memberof PasswordSyncGroup */ 'id'?: string; /** * Name of the sync group * @type {string} * @memberof PasswordSyncGroup */ 'name'?: string; /** * ID of the password policy * @type {string} * @memberof PasswordSyncGroup */ 'passwordPolicyId'?: string; /** * List of password managed sources IDs * @type {Array} * @memberof PasswordSyncGroup */ 'sourceIds'?: Array; /** * The date and time this sync group was created * @type {string} * @memberof PasswordSyncGroup */ 'created'?: string | null; /** * The date and time this sync group was last modified * @type {string} * @memberof PasswordSyncGroup */ 'modified'?: string | null; } /** * PasswordSyncGroupsApi - axios parameter creator * @export */ export declare const PasswordSyncGroupsApiAxiosParamCreator: (configuration?: Configuration) => { /** * This API creates a password sync group based on the specifications provided. * @summary Create password sync group * @param {PasswordSyncGroup} passwordSyncGroup * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPasswordSyncGroupV1: (passwordSyncGroup: PasswordSyncGroup, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API deletes the specified password sync group. * @summary Delete password sync group by id * @param {string} id The ID of password sync group to delete. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePasswordSyncGroupV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API returns the sync group for the specified ID. * @summary Get password sync group by id * @param {string} id The ID of password sync group to retrieve. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPasswordSyncGroupV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API returns a list of password sync groups. * @summary Get password sync group list * @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 {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPasswordSyncGroupsV1: (limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API updates the specified password sync group. * @summary Update password sync group by id * @param {string} id The ID of password sync group to update. * @param {PasswordSyncGroup} passwordSyncGroup * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePasswordSyncGroupV1: (id: string, passwordSyncGroup: PasswordSyncGroup, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * PasswordSyncGroupsApi - functional programming interface * @export */ export declare const PasswordSyncGroupsApiFp: (configuration?: Configuration) => { /** * This API creates a password sync group based on the specifications provided. * @summary Create password sync group * @param {PasswordSyncGroup} passwordSyncGroup * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPasswordSyncGroupV1(passwordSyncGroup: PasswordSyncGroup, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API deletes the specified password sync group. * @summary Delete password sync group by id * @param {string} id The ID of password sync group to delete. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePasswordSyncGroupV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API returns the sync group for the specified ID. * @summary Get password sync group by id * @param {string} id The ID of password sync group to retrieve. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPasswordSyncGroupV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API returns a list of password sync groups. * @summary Get password sync group list * @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 {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPasswordSyncGroupsV1(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This API updates the specified password sync group. * @summary Update password sync group by id * @param {string} id The ID of password sync group to update. * @param {PasswordSyncGroup} passwordSyncGroup * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePasswordSyncGroupV1(id: string, passwordSyncGroup: PasswordSyncGroup, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PasswordSyncGroupsApi - factory interface * @export */ export declare const PasswordSyncGroupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This API creates a password sync group based on the specifications provided. * @summary Create password sync group * @param {PasswordSyncGroupsApiCreatePasswordSyncGroupV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPasswordSyncGroupV1(requestParameters: PasswordSyncGroupsApiCreatePasswordSyncGroupV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API deletes the specified password sync group. * @summary Delete password sync group by id * @param {PasswordSyncGroupsApiDeletePasswordSyncGroupV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePasswordSyncGroupV1(requestParameters: PasswordSyncGroupsApiDeletePasswordSyncGroupV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API returns the sync group for the specified ID. * @summary Get password sync group by id * @param {PasswordSyncGroupsApiGetPasswordSyncGroupV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPasswordSyncGroupV1(requestParameters: PasswordSyncGroupsApiGetPasswordSyncGroupV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API returns a list of password sync groups. * @summary Get password sync group list * @param {PasswordSyncGroupsApiGetPasswordSyncGroupsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPasswordSyncGroupsV1(requestParameters?: PasswordSyncGroupsApiGetPasswordSyncGroupsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This API updates the specified password sync group. * @summary Update password sync group by id * @param {PasswordSyncGroupsApiUpdatePasswordSyncGroupV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePasswordSyncGroupV1(requestParameters: PasswordSyncGroupsApiUpdatePasswordSyncGroupV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createPasswordSyncGroupV1 operation in PasswordSyncGroupsApi. * @export * @interface PasswordSyncGroupsApiCreatePasswordSyncGroupV1Request */ export interface PasswordSyncGroupsApiCreatePasswordSyncGroupV1Request { /** * * @type {PasswordSyncGroup} * @memberof PasswordSyncGroupsApiCreatePasswordSyncGroupV1 */ readonly passwordSyncGroup: PasswordSyncGroup; } /** * Request parameters for deletePasswordSyncGroupV1 operation in PasswordSyncGroupsApi. * @export * @interface PasswordSyncGroupsApiDeletePasswordSyncGroupV1Request */ export interface PasswordSyncGroupsApiDeletePasswordSyncGroupV1Request { /** * The ID of password sync group to delete. * @type {string} * @memberof PasswordSyncGroupsApiDeletePasswordSyncGroupV1 */ readonly id: string; } /** * Request parameters for getPasswordSyncGroupV1 operation in PasswordSyncGroupsApi. * @export * @interface PasswordSyncGroupsApiGetPasswordSyncGroupV1Request */ export interface PasswordSyncGroupsApiGetPasswordSyncGroupV1Request { /** * The ID of password sync group to retrieve. * @type {string} * @memberof PasswordSyncGroupsApiGetPasswordSyncGroupV1 */ readonly id: string; } /** * Request parameters for getPasswordSyncGroupsV1 operation in PasswordSyncGroupsApi. * @export * @interface PasswordSyncGroupsApiGetPasswordSyncGroupsV1Request */ export interface PasswordSyncGroupsApiGetPasswordSyncGroupsV1Request { /** * 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 PasswordSyncGroupsApiGetPasswordSyncGroupsV1 */ 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 PasswordSyncGroupsApiGetPasswordSyncGroupsV1 */ 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 PasswordSyncGroupsApiGetPasswordSyncGroupsV1 */ readonly count?: boolean; } /** * Request parameters for updatePasswordSyncGroupV1 operation in PasswordSyncGroupsApi. * @export * @interface PasswordSyncGroupsApiUpdatePasswordSyncGroupV1Request */ export interface PasswordSyncGroupsApiUpdatePasswordSyncGroupV1Request { /** * The ID of password sync group to update. * @type {string} * @memberof PasswordSyncGroupsApiUpdatePasswordSyncGroupV1 */ readonly id: string; /** * * @type {PasswordSyncGroup} * @memberof PasswordSyncGroupsApiUpdatePasswordSyncGroupV1 */ readonly passwordSyncGroup: PasswordSyncGroup; } /** * PasswordSyncGroupsApi - object-oriented interface * @export * @class PasswordSyncGroupsApi * @extends {BaseAPI} */ export declare class PasswordSyncGroupsApi extends BaseAPI { /** * This API creates a password sync group based on the specifications provided. * @summary Create password sync group * @param {PasswordSyncGroupsApiCreatePasswordSyncGroupV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PasswordSyncGroupsApi */ createPasswordSyncGroupV1(requestParameters: PasswordSyncGroupsApiCreatePasswordSyncGroupV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API deletes the specified password sync group. * @summary Delete password sync group by id * @param {PasswordSyncGroupsApiDeletePasswordSyncGroupV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PasswordSyncGroupsApi */ deletePasswordSyncGroupV1(requestParameters: PasswordSyncGroupsApiDeletePasswordSyncGroupV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API returns the sync group for the specified ID. * @summary Get password sync group by id * @param {PasswordSyncGroupsApiGetPasswordSyncGroupV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PasswordSyncGroupsApi */ getPasswordSyncGroupV1(requestParameters: PasswordSyncGroupsApiGetPasswordSyncGroupV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API returns a list of password sync groups. * @summary Get password sync group list * @param {PasswordSyncGroupsApiGetPasswordSyncGroupsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PasswordSyncGroupsApi */ getPasswordSyncGroupsV1(requestParameters?: PasswordSyncGroupsApiGetPasswordSyncGroupsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API updates the specified password sync group. * @summary Update password sync group by id * @param {PasswordSyncGroupsApiUpdatePasswordSyncGroupV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PasswordSyncGroupsApi */ updatePasswordSyncGroupV1(requestParameters: PasswordSyncGroupsApiUpdatePasswordSyncGroupV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }