/** * Identity Security Cloud API - IAI Common Access * 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 CommonAccessIDStatus */ export interface CommonAccessIDStatus { /** * List of confirmed common access ids. * @type {Array} * @memberof CommonAccessIDStatus */ 'confirmedIds'?: Array; /** * List of denied common access ids. * @type {Array} * @memberof CommonAccessIDStatus */ 'deniedIds'?: Array; } /** * * @export * @interface CommonAccessItemAccess */ export interface CommonAccessItemAccess { /** * Common access ID * @type {string} * @memberof CommonAccessItemAccess */ 'id'?: string; /** * * @type {CommonAccessType} * @memberof CommonAccessItemAccess */ 'type'?: CommonAccessType; /** * Common access name * @type {string} * @memberof CommonAccessItemAccess */ 'name'?: string; /** * Common access description * @type {string} * @memberof CommonAccessItemAccess */ 'description'?: string | null; /** * Common access owner name * @type {string} * @memberof CommonAccessItemAccess */ 'ownerName'?: string; /** * Common access owner ID * @type {string} * @memberof CommonAccessItemAccess */ 'ownerId'?: string; } /** * * @export * @interface CommonAccessItemRequest */ export interface CommonAccessItemRequest { /** * * @type {CommonAccessItemAccess} * @memberof CommonAccessItemRequest */ 'access'?: CommonAccessItemAccess; /** * * @type {CommonAccessItemState} * @memberof CommonAccessItemRequest */ 'status'?: CommonAccessItemState; } /** * * @export * @interface CommonAccessItemResponse */ export interface CommonAccessItemResponse { /** * Common Access Item ID * @type {string} * @memberof CommonAccessItemResponse */ 'id'?: string; /** * * @type {CommonAccessItemAccess} * @memberof CommonAccessItemResponse */ 'access'?: CommonAccessItemAccess; /** * * @type {CommonAccessItemState} * @memberof CommonAccessItemResponse */ 'status'?: CommonAccessItemState; /** * * @type {string} * @memberof CommonAccessItemResponse */ 'lastUpdated'?: string; /** * * @type {boolean} * @memberof CommonAccessItemResponse */ 'reviewedByUser'?: boolean; /** * * @type {string} * @memberof CommonAccessItemResponse */ 'lastReviewed'?: string; /** * * @type {string} * @memberof CommonAccessItemResponse */ 'createdByUser'?: string; } /** * State of common access item. * @export * @enum {string} */ export declare const CommonAccessItemState: { readonly Confirmed: "CONFIRMED"; readonly Denied: "DENIED"; }; export type CommonAccessItemState = typeof CommonAccessItemState[keyof typeof CommonAccessItemState]; /** * * @export * @interface CommonAccessResponse */ export interface CommonAccessResponse { /** * Unique ID of the common access item * @type {string} * @memberof CommonAccessResponse */ 'id'?: string; /** * * @type {CommonAccessItemAccess} * @memberof CommonAccessResponse */ 'access'?: CommonAccessItemAccess; /** * CONFIRMED or DENIED * @type {string} * @memberof CommonAccessResponse */ 'status'?: string; /** * * @type {string} * @memberof CommonAccessResponse */ 'commonAccessType'?: string; /** * * @type {string} * @memberof CommonAccessResponse */ 'lastUpdated'?: string; /** * true if user has confirmed or denied status * @type {boolean} * @memberof CommonAccessResponse */ 'reviewedByUser'?: boolean; /** * * @type {string} * @memberof CommonAccessResponse */ 'lastReviewed'?: string | null; /** * * @type {boolean} * @memberof CommonAccessResponse */ 'createdByUser'?: boolean; } /** * The type of access item. * @export * @enum {string} */ export declare const CommonAccessType: { readonly AccessProfile: "ACCESS_PROFILE"; readonly Role: "ROLE"; }; export type CommonAccessType = typeof CommonAccessType[keyof typeof CommonAccessType]; /** * * @export * @interface CreateCommonAccessV1429Response */ export interface CreateCommonAccessV1429Response { /** * A message describing the error * @type {any} * @memberof CreateCommonAccessV1429Response */ 'message'?: any; } /** * * @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 GetCommonAccessV1401Response */ export interface GetCommonAccessV1401Response { /** * A message describing the error * @type {any} * @memberof GetCommonAccessV1401Response */ 'error'?: 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]; /** * IAICommonAccessApi - axios parameter creator * @export */ export declare const IAICommonAccessApiAxiosParamCreator: (configuration?: Configuration) => { /** * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create * @summary Create common access items * @param {CommonAccessItemRequest} commonAccessItemRequest * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCommonAccessV1: (commonAccessItemRequest: CommonAccessItemRequest, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read * @summary Get a paginated list of common access * @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 {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 {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} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getCommonAccessV1: (offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update * @summary Bulk update common access status * @param {Array} commonAccessIDStatus Confirm or deny in bulk the common access ids that are (or aren\'t) common access * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateCommonAccessStatusInBulkV1: (commonAccessIDStatus: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * IAICommonAccessApi - functional programming interface * @export */ export declare const IAICommonAccessApiFp: (configuration?: Configuration) => { /** * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create * @summary Create common access items * @param {CommonAccessItemRequest} commonAccessItemRequest * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCommonAccessV1(commonAccessItemRequest: CommonAccessItemRequest, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read * @summary Get a paginated list of common access * @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 {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 {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} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getCommonAccessV1(offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update * @summary Bulk update common access status * @param {Array} commonAccessIDStatus Confirm or deny in bulk the common access ids that are (or aren\'t) common access * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateCommonAccessStatusInBulkV1(commonAccessIDStatus: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * IAICommonAccessApi - factory interface * @export */ export declare const IAICommonAccessApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create * @summary Create common access items * @param {IAICommonAccessApiCreateCommonAccessV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCommonAccessV1(requestParameters: IAICommonAccessApiCreateCommonAccessV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read * @summary Get a paginated list of common access * @param {IAICommonAccessApiGetCommonAccessV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getCommonAccessV1(requestParameters?: IAICommonAccessApiGetCommonAccessV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update * @summary Bulk update common access status * @param {IAICommonAccessApiUpdateCommonAccessStatusInBulkV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateCommonAccessStatusInBulkV1(requestParameters: IAICommonAccessApiUpdateCommonAccessStatusInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createCommonAccessV1 operation in IAICommonAccessApi. * @export * @interface IAICommonAccessApiCreateCommonAccessV1Request */ export interface IAICommonAccessApiCreateCommonAccessV1Request { /** * * @type {CommonAccessItemRequest} * @memberof IAICommonAccessApiCreateCommonAccessV1 */ readonly commonAccessItemRequest: CommonAccessItemRequest; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAICommonAccessApiCreateCommonAccessV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getCommonAccessV1 operation in IAICommonAccessApi. * @export * @interface IAICommonAccessApiGetCommonAccessV1Request */ export interface IAICommonAccessApiGetCommonAccessV1Request { /** * 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 IAICommonAccessApiGetCommonAccessV1 */ readonly offset?: number; /** * 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 IAICommonAccessApiGetCommonAccessV1 */ readonly limit?: 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 IAICommonAccessApiGetCommonAccessV1 */ readonly count?: boolean; /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* * @type {string} * @memberof IAICommonAccessApiGetCommonAccessV1 */ readonly filters?: string; /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. * @type {string} * @memberof IAICommonAccessApiGetCommonAccessV1 */ readonly sorters?: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAICommonAccessApiGetCommonAccessV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for updateCommonAccessStatusInBulkV1 operation in IAICommonAccessApi. * @export * @interface IAICommonAccessApiUpdateCommonAccessStatusInBulkV1Request */ export interface IAICommonAccessApiUpdateCommonAccessStatusInBulkV1Request { /** * Confirm or deny in bulk the common access ids that are (or aren\'t) common access * @type {Array} * @memberof IAICommonAccessApiUpdateCommonAccessStatusInBulkV1 */ readonly commonAccessIDStatus: Array; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAICommonAccessApiUpdateCommonAccessStatusInBulkV1 */ readonly xSailPointExperimental?: string; } /** * IAICommonAccessApi - object-oriented interface * @export * @class IAICommonAccessApi * @extends {BaseAPI} */ export declare class IAICommonAccessApi extends BaseAPI { /** * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create * @summary Create common access items * @param {IAICommonAccessApiCreateCommonAccessV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAICommonAccessApi */ createCommonAccessV1(requestParameters: IAICommonAccessApiCreateCommonAccessV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read * @summary Get a paginated list of common access * @param {IAICommonAccessApiGetCommonAccessV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAICommonAccessApi */ getCommonAccessV1(requestParameters?: IAICommonAccessApiGetCommonAccessV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update * @summary Bulk update common access status * @param {IAICommonAccessApiUpdateCommonAccessStatusInBulkV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAICommonAccessApi */ updateCommonAccessStatusInBulkV1(requestParameters: IAICommonAccessApiUpdateCommonAccessStatusInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }