/** * Identity Security Cloud API - Role Propagation * 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; } /** * 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]; /** * Role Change Propagation Config Input * @export * @interface Rolepropagationconfiginput */ export interface Rolepropagationconfiginput { /** * Indicates if the Role Change Propagation process should be enabled for the tenant * @type {boolean} * @memberof Rolepropagationconfiginput */ 'enabled'?: boolean; } /** * Role Change Propagation Config Response * @export * @interface Rolepropagationconfigresponse */ export interface Rolepropagationconfigresponse { /** * Indicates if the Role Change Propagation process is enabled for the tenant * @type {boolean} * @memberof Rolepropagationconfigresponse */ 'enabled'?: boolean; /** * The time when Role Change Propagation Process was last enabled on the tenant * @type {string} * @memberof Rolepropagationconfigresponse */ 'enabledDate'?: string; /** * The time when Role Change Propagation Configuration was first created for the tenant * @type {string} * @memberof Rolepropagationconfigresponse */ 'createdDate'?: string; /** * The time when Role Change Propagation Config was updated on the tenant * @type {string} * @memberof Rolepropagationconfigresponse */ 'modifiedDate'?: string; } /** * Running Role Propagation Response * @export * @interface Rolepropagationongoingresponse */ export interface Rolepropagationongoingresponse { /** * Indicates if the role propagation process is currently running on the tenant * @type {boolean} * @memberof Rolepropagationongoingresponse */ 'isRunning'?: boolean; /** * * @type {RolepropagationongoingresponseRolePropagationDetails} * @memberof Rolepropagationongoingresponse */ 'rolePropagationDetails'?: RolepropagationongoingresponseRolePropagationDetails; } /** * Details of the ongoing role propagation process * @export * @interface RolepropagationongoingresponseRolePropagationDetails */ export interface RolepropagationongoingresponseRolePropagationDetails { /** * Id of the Role Propagation process triggered. * @type {string} * @memberof RolepropagationongoingresponseRolePropagationDetails */ 'id'?: string; /** * Status of the Role Propagation process. * @type {string} * @memberof RolepropagationongoingresponseRolePropagationDetails */ 'status'?: RolepropagationongoingresponseRolePropagationDetailsStatusEnum; /** * Current execution stage of the Role Propagation process. * @type {string} * @memberof RolepropagationongoingresponseRolePropagationDetails */ 'executionStage'?: RolepropagationongoingresponseRolePropagationDetailsExecutionStageEnum; /** * Time when the Role Propagation process was launched. * @type {string} * @memberof RolepropagationongoingresponseRolePropagationDetails */ 'launched'?: string; /** * * @type {RolepropagationstatusresponseLaunchedBy} * @memberof RolepropagationongoingresponseRolePropagationDetails */ 'launchedBy'?: RolepropagationstatusresponseLaunchedBy; /** * * @type {RolepropagationstatusresponseTerminatedBy} * @memberof RolepropagationongoingresponseRolePropagationDetails */ 'terminatedBy'?: RolepropagationstatusresponseTerminatedBy; /** * Time when the Role Propagation process was completed. * @type {string} * @memberof RolepropagationongoingresponseRolePropagationDetails */ 'completed'?: string; /** * Reason for failure if the Role Propagation process failed. * @type {string} * @memberof RolepropagationongoingresponseRolePropagationDetails */ 'failureReason'?: string; /** * Indicates if the role refresh was skipped during the Role Propagation process. * @type {boolean} * @memberof RolepropagationongoingresponseRolePropagationDetails */ 'skipRoleRefresh'?: boolean; } export declare const RolepropagationongoingresponseRolePropagationDetailsStatusEnum: { readonly Running: "RUNNING"; readonly Completed: "COMPLETED"; }; export type RolepropagationongoingresponseRolePropagationDetailsStatusEnum = typeof RolepropagationongoingresponseRolePropagationDetailsStatusEnum[keyof typeof RolepropagationongoingresponseRolePropagationDetailsStatusEnum]; export declare const RolepropagationongoingresponseRolePropagationDetailsExecutionStageEnum: { readonly Pending: "PENDING"; readonly DataAggregationRunning: "DATA_AGGREGATION_RUNNING"; readonly LaunchProvisioning: "LAUNCH_PROVISIONING"; readonly Succeeded: "SUCCEEDED"; readonly Failed: "FAILED"; readonly Terminated: "TERMINATED"; }; export type RolepropagationongoingresponseRolePropagationDetailsExecutionStageEnum = typeof RolepropagationongoingresponseRolePropagationDetailsExecutionStageEnum[keyof typeof RolepropagationongoingresponseRolePropagationDetailsExecutionStageEnum]; /** * Role Propagation Response * @export * @interface Rolepropagationresponse */ export interface Rolepropagationresponse { /** * Id of the Role Propagation process triggered. * @type {string} * @memberof Rolepropagationresponse */ 'rolePropagationId'?: string; } /** * Role Propagation Status Response * @export * @interface Rolepropagationstatusresponse */ export interface Rolepropagationstatusresponse { /** * Id of the Role Propagation process triggered. * @type {string} * @memberof Rolepropagationstatusresponse */ 'id'?: string; /** * Status of the Role Propagation process. * @type {string} * @memberof Rolepropagationstatusresponse */ 'status'?: RolepropagationstatusresponseStatusEnum; /** * Current execution stage of the Role Propagation process. * @type {string} * @memberof Rolepropagationstatusresponse */ 'executionStage'?: RolepropagationstatusresponseExecutionStageEnum; /** * Time when the Role Propagation process was launched. * @type {string} * @memberof Rolepropagationstatusresponse */ 'launched'?: string; /** * * @type {RolepropagationstatusresponseLaunchedBy} * @memberof Rolepropagationstatusresponse */ 'launchedBy'?: RolepropagationstatusresponseLaunchedBy; /** * * @type {RolepropagationstatusresponseTerminatedBy} * @memberof Rolepropagationstatusresponse */ 'terminatedBy'?: RolepropagationstatusresponseTerminatedBy; /** * Time when the Role Propagation process was completed. * @type {string} * @memberof Rolepropagationstatusresponse */ 'completed'?: string; /** * Reason for failure if the Role Propagation process failed. * @type {string} * @memberof Rolepropagationstatusresponse */ 'failureReason'?: string; /** * Indicates if the role refresh was skipped during the Role Propagation process. * @type {boolean} * @memberof Rolepropagationstatusresponse */ 'skipRoleRefresh'?: boolean; } export declare const RolepropagationstatusresponseStatusEnum: { readonly Running: "RUNNING"; readonly Completed: "COMPLETED"; }; export type RolepropagationstatusresponseStatusEnum = typeof RolepropagationstatusresponseStatusEnum[keyof typeof RolepropagationstatusresponseStatusEnum]; export declare const RolepropagationstatusresponseExecutionStageEnum: { readonly Pending: "PENDING"; readonly DataAggregationRunning: "DATA_AGGREGATION_RUNNING"; readonly LaunchProvisioning: "LAUNCH_PROVISIONING"; readonly Succeeded: "SUCCEEDED"; readonly Failed: "FAILED"; readonly Terminated: "TERMINATED"; }; export type RolepropagationstatusresponseExecutionStageEnum = typeof RolepropagationstatusresponseExecutionStageEnum[keyof typeof RolepropagationstatusresponseExecutionStageEnum]; /** * Identity who launched the Role Propagation process. * @export * @interface RolepropagationstatusresponseLaunchedBy */ export interface RolepropagationstatusresponseLaunchedBy { /** * DTO type of the identity who launched the Role Propagation process. * @type {string} * @memberof RolepropagationstatusresponseLaunchedBy */ 'type'?: RolepropagationstatusresponseLaunchedByTypeEnum; /** * ID of the identity who launched the Role Propagation process. * @type {string} * @memberof RolepropagationstatusresponseLaunchedBy */ 'id'?: string; /** * Name of the identity who launched the Role Propagation process. * @type {string} * @memberof RolepropagationstatusresponseLaunchedBy */ 'name'?: string; } export declare const RolepropagationstatusresponseLaunchedByTypeEnum: { readonly Identity: "IDENTITY"; }; export type RolepropagationstatusresponseLaunchedByTypeEnum = typeof RolepropagationstatusresponseLaunchedByTypeEnum[keyof typeof RolepropagationstatusresponseLaunchedByTypeEnum]; /** * Identity who terminated the Role Propagation process. * @export * @interface RolepropagationstatusresponseTerminatedBy */ export interface RolepropagationstatusresponseTerminatedBy { /** * DTO type of the Identity who terminated the Role Propagation process. * @type {string} * @memberof RolepropagationstatusresponseTerminatedBy */ 'type'?: RolepropagationstatusresponseTerminatedByTypeEnum; /** * ID of the Identity who terminated the Role Propagation process. * @type {string} * @memberof RolepropagationstatusresponseTerminatedBy */ 'id'?: string; /** * Name of the Identity who terminated the Role Propagation process. * @type {string} * @memberof RolepropagationstatusresponseTerminatedBy */ 'name'?: string; } export declare const RolepropagationstatusresponseTerminatedByTypeEnum: { readonly Identity: "IDENTITY"; }; export type RolepropagationstatusresponseTerminatedByTypeEnum = typeof RolepropagationstatusresponseTerminatedByTypeEnum[keyof typeof RolepropagationstatusresponseTerminatedByTypeEnum]; /** * * @export * @interface StartRolePropagationV1401Response */ export interface StartRolePropagationV1401Response { /** * A message describing the error * @type {any} * @memberof StartRolePropagationV1401Response */ 'error'?: any; } /** * * @export * @interface StartRolePropagationV1429Response */ export interface StartRolePropagationV1429Response { /** * A message describing the error * @type {any} * @memberof StartRolePropagationV1429Response */ 'message'?: any; } /** * RolePropagationApi - axios parameter creator * @export */ export declare const RolePropagationApiAxiosParamCreator: (configuration?: Configuration) => { /** * This endpoint terminates the ongoing role change propagation process for a tenant. * @summary Terminate Role Propagation process * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ cancelRolePropagationV1: (xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint returns the information of ongoing role change propagation process for a tenant. It returns the information whether the role propagation process is currently running or not, If it is running it returns the details of the ongoing role propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. * @summary Get ongoing Role Propagation process * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getOngoingRolePropagationV1: (xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint fetches the Role Change Propagation Configuration for the tenant * @summary Get Role Change Propagation Configuration * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRolePropagationConfigV1: (xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint returns the information of the specified role change propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. * @summary Get status of Role-Propagation process * @param {string} rolePropagationId The ID of the role propagation process to retrieve the status for. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRolePropagationStatusV1: (rolePropagationId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint enables or disables the Role Change Propagation Process for the tenant * @summary Update Role Change Propagation Configuration * @param {Rolepropagationconfiginput} rolepropagationconfiginput * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setRolePropagationConfigV1: (rolepropagationconfiginput: Rolepropagationconfiginput, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint initiates a role change propagation process for a tenant asynchronously. If all preconditions are met, the request is accepted and a rolePropagationId is returned which can be used to view the status. API throws 4xx if any of the following conditions are met - Role propagation feature is disabled - There is an ongoing role propagation for the tenant - Role refresh needs to be kicked off as part of the role propagation (skipRoleRefresh=false) and there is an ongoing refresh for the tenant * @summary Initiate Role Propagation process * @param {boolean} [skipRoleRefresh] When true, the role refresh is not performed. Keeping it false is recommended. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startRolePropagationV1: (skipRoleRefresh?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * RolePropagationApi - functional programming interface * @export */ export declare const RolePropagationApiFp: (configuration?: Configuration) => { /** * This endpoint terminates the ongoing role change propagation process for a tenant. * @summary Terminate Role Propagation process * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ cancelRolePropagationV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint returns the information of ongoing role change propagation process for a tenant. It returns the information whether the role propagation process is currently running or not, If it is running it returns the details of the ongoing role propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. * @summary Get ongoing Role Propagation process * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getOngoingRolePropagationV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint fetches the Role Change Propagation Configuration for the tenant * @summary Get Role Change Propagation Configuration * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRolePropagationConfigV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint returns the information of the specified role change propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. * @summary Get status of Role-Propagation process * @param {string} rolePropagationId The ID of the role propagation process to retrieve the status for. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRolePropagationStatusV1(rolePropagationId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint enables or disables the Role Change Propagation Process for the tenant * @summary Update Role Change Propagation Configuration * @param {Rolepropagationconfiginput} rolepropagationconfiginput * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setRolePropagationConfigV1(rolepropagationconfiginput: Rolepropagationconfiginput, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint initiates a role change propagation process for a tenant asynchronously. If all preconditions are met, the request is accepted and a rolePropagationId is returned which can be used to view the status. API throws 4xx if any of the following conditions are met - Role propagation feature is disabled - There is an ongoing role propagation for the tenant - Role refresh needs to be kicked off as part of the role propagation (skipRoleRefresh=false) and there is an ongoing refresh for the tenant * @summary Initiate Role Propagation process * @param {boolean} [skipRoleRefresh] When true, the role refresh is not performed. Keeping it false is recommended. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startRolePropagationV1(skipRoleRefresh?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * RolePropagationApi - factory interface * @export */ export declare const RolePropagationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This endpoint terminates the ongoing role change propagation process for a tenant. * @summary Terminate Role Propagation process * @param {RolePropagationApiCancelRolePropagationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ cancelRolePropagationV1(requestParameters?: RolePropagationApiCancelRolePropagationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint returns the information of ongoing role change propagation process for a tenant. It returns the information whether the role propagation process is currently running or not, If it is running it returns the details of the ongoing role propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. * @summary Get ongoing Role Propagation process * @param {RolePropagationApiGetOngoingRolePropagationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getOngoingRolePropagationV1(requestParameters?: RolePropagationApiGetOngoingRolePropagationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint fetches the Role Change Propagation Configuration for the tenant * @summary Get Role Change Propagation Configuration * @param {RolePropagationApiGetRolePropagationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRolePropagationConfigV1(requestParameters?: RolePropagationApiGetRolePropagationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint returns the information of the specified role change propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. * @summary Get status of Role-Propagation process * @param {RolePropagationApiGetRolePropagationStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRolePropagationStatusV1(requestParameters: RolePropagationApiGetRolePropagationStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint enables or disables the Role Change Propagation Process for the tenant * @summary Update Role Change Propagation Configuration * @param {RolePropagationApiSetRolePropagationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setRolePropagationConfigV1(requestParameters: RolePropagationApiSetRolePropagationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint initiates a role change propagation process for a tenant asynchronously. If all preconditions are met, the request is accepted and a rolePropagationId is returned which can be used to view the status. API throws 4xx if any of the following conditions are met - Role propagation feature is disabled - There is an ongoing role propagation for the tenant - Role refresh needs to be kicked off as part of the role propagation (skipRoleRefresh=false) and there is an ongoing refresh for the tenant * @summary Initiate Role Propagation process * @param {RolePropagationApiStartRolePropagationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startRolePropagationV1(requestParameters?: RolePropagationApiStartRolePropagationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for cancelRolePropagationV1 operation in RolePropagationApi. * @export * @interface RolePropagationApiCancelRolePropagationV1Request */ export interface RolePropagationApiCancelRolePropagationV1Request { /** * Use this header to enable this experimental API. * @type {string} * @memberof RolePropagationApiCancelRolePropagationV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getOngoingRolePropagationV1 operation in RolePropagationApi. * @export * @interface RolePropagationApiGetOngoingRolePropagationV1Request */ export interface RolePropagationApiGetOngoingRolePropagationV1Request { /** * Use this header to enable this experimental API. * @type {string} * @memberof RolePropagationApiGetOngoingRolePropagationV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getRolePropagationConfigV1 operation in RolePropagationApi. * @export * @interface RolePropagationApiGetRolePropagationConfigV1Request */ export interface RolePropagationApiGetRolePropagationConfigV1Request { /** * Use this header to enable this experimental API. * @type {string} * @memberof RolePropagationApiGetRolePropagationConfigV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getRolePropagationStatusV1 operation in RolePropagationApi. * @export * @interface RolePropagationApiGetRolePropagationStatusV1Request */ export interface RolePropagationApiGetRolePropagationStatusV1Request { /** * The ID of the role propagation process to retrieve the status for. * @type {string} * @memberof RolePropagationApiGetRolePropagationStatusV1 */ readonly rolePropagationId: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof RolePropagationApiGetRolePropagationStatusV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for setRolePropagationConfigV1 operation in RolePropagationApi. * @export * @interface RolePropagationApiSetRolePropagationConfigV1Request */ export interface RolePropagationApiSetRolePropagationConfigV1Request { /** * * @type {Rolepropagationconfiginput} * @memberof RolePropagationApiSetRolePropagationConfigV1 */ readonly rolepropagationconfiginput: Rolepropagationconfiginput; /** * Use this header to enable this experimental API. * @type {string} * @memberof RolePropagationApiSetRolePropagationConfigV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for startRolePropagationV1 operation in RolePropagationApi. * @export * @interface RolePropagationApiStartRolePropagationV1Request */ export interface RolePropagationApiStartRolePropagationV1Request { /** * When true, the role refresh is not performed. Keeping it false is recommended. * @type {boolean} * @memberof RolePropagationApiStartRolePropagationV1 */ readonly skipRoleRefresh?: boolean; /** * Use this header to enable this experimental API. * @type {string} * @memberof RolePropagationApiStartRolePropagationV1 */ readonly xSailPointExperimental?: string; } /** * RolePropagationApi - object-oriented interface * @export * @class RolePropagationApi * @extends {BaseAPI} */ export declare class RolePropagationApi extends BaseAPI { /** * This endpoint terminates the ongoing role change propagation process for a tenant. * @summary Terminate Role Propagation process * @param {RolePropagationApiCancelRolePropagationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RolePropagationApi */ cancelRolePropagationV1(requestParameters?: RolePropagationApiCancelRolePropagationV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint returns the information of ongoing role change propagation process for a tenant. It returns the information whether the role propagation process is currently running or not, If it is running it returns the details of the ongoing role propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. * @summary Get ongoing Role Propagation process * @param {RolePropagationApiGetOngoingRolePropagationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RolePropagationApi */ getOngoingRolePropagationV1(requestParameters?: RolePropagationApiGetOngoingRolePropagationV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint fetches the Role Change Propagation Configuration for the tenant * @summary Get Role Change Propagation Configuration * @param {RolePropagationApiGetRolePropagationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RolePropagationApi */ getRolePropagationConfigV1(requestParameters?: RolePropagationApiGetRolePropagationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint returns the information of the specified role change propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. * @summary Get status of Role-Propagation process * @param {RolePropagationApiGetRolePropagationStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RolePropagationApi */ getRolePropagationStatusV1(requestParameters: RolePropagationApiGetRolePropagationStatusV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint enables or disables the Role Change Propagation Process for the tenant * @summary Update Role Change Propagation Configuration * @param {RolePropagationApiSetRolePropagationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RolePropagationApi */ setRolePropagationConfigV1(requestParameters: RolePropagationApiSetRolePropagationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint initiates a role change propagation process for a tenant asynchronously. If all preconditions are met, the request is accepted and a rolePropagationId is returned which can be used to view the status. API throws 4xx if any of the following conditions are met - Role propagation feature is disabled - There is an ongoing role propagation for the tenant - Role refresh needs to be kicked off as part of the role propagation (skipRoleRefresh=false) and there is an ongoing refresh for the tenant * @summary Initiate Role Propagation process * @param {RolePropagationApiStartRolePropagationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RolePropagationApi */ startRolePropagationV1(requestParameters?: RolePropagationApiStartRolePropagationV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }