/** * Identity Security Cloud API - JIT 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 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 GetJitActivationConfigV1401Response */ export interface GetJitActivationConfigV1401Response { /** * A message describing the error * @type {any} * @memberof GetJitActivationConfigV1401Response */ 'error'?: any; } /** * * @export * @interface GetJitActivationConfigV1429Response */ export interface GetJitActivationConfigV1429Response { /** * A message describing the error * @type {any} * @memberof GetJitActivationConfigV1429Response */ 'message'?: any; } /** * * @export * @interface JITActivationConfigResponse */ export interface JITActivationConfigResponse { /** * Unique identifier of this JIT activation configuration instance (persisted config id). * @type {string} * @memberof JITActivationConfigResponse */ 'id': string; /** * Entitlement IDs governed by JIT activation policy. May be a single-element array when only one entitlement is in scope. * @type {Array} * @memberof JITActivationConfigResponse */ 'entitlementIds'?: Array; /** * Maximum allowed JIT activation duration for a single grant, in minutes; null if unset. * @type {number} * @memberof JITActivationConfigResponse */ 'maxActivationPeriodMins'?: number | null; /** * Maximum allowed extension of an active JIT activation, in minutes; null if unset. * @type {number} * @memberof JITActivationConfigResponse */ 'maxActivationPeriodExtensionMins'?: number | null; /** * Default activation duration offered when a user requests JIT access, in minutes; null if unset. * @type {number} * @memberof JITActivationConfigResponse */ 'defaultMaxActivationPeriodMins'?: number | null; /** * Default extension duration offered for an active JIT activation, in minutes; null if unset. * @type {number} * @memberof JITActivationConfigResponse */ 'defaultMaxActivationPeriodExtensionMins'?: number | null; /** * Email addresses notified for JIT activation events (for example policy owners or a shared mailbox). * @type {Array} * @memberof JITActivationConfigResponse */ 'notificationRecipients'?: Array; /** * Name or key of the email template used for JIT activation notifications; null if unset. * @type {string} * @memberof JITActivationConfigResponse */ 'notificationTemplate'?: string | null; /** * Whether the policy applies to future entitlement assignments. * @type {boolean} * @memberof JITActivationConfigResponse */ 'applyToFutureAssignments': boolean; } /** * A single replace operation applied to JIT activation configuration. Only **replace** is supported. **path** must be one of the allowed JSON Pointer-style paths. * @export * @interface JitAccessOperationRequest */ export interface JitAccessOperationRequest { /** * Operation type. Defaults to `replace` if omitted. * @type {string} * @memberof JitAccessOperationRequest */ 'op'?: JitAccessOperationRequestOpEnum; /** * Path to replace. Only the following JSON Pointer-style paths are supported. * @type {string} * @memberof JitAccessOperationRequest */ 'path': JitAccessOperationRequestPathEnum; /** * * @type {JitAccessOperationRequestValue} * @memberof JitAccessOperationRequest */ 'value': JitAccessOperationRequestValue | null; } export declare const JitAccessOperationRequestOpEnum: { readonly Replace: "replace"; }; export type JitAccessOperationRequestOpEnum = typeof JitAccessOperationRequestOpEnum[keyof typeof JitAccessOperationRequestOpEnum]; export declare const JitAccessOperationRequestPathEnum: { readonly EntitlementIds: "/entitlementIds"; readonly MaxActivationPeriodMins: "/maxActivationPeriodMins"; readonly MaxActivationPeriodExtensionMins: "/maxActivationPeriodExtensionMins"; readonly DefaultMaxActivationPeriodMins: "/defaultMaxActivationPeriodMins"; readonly DefaultMaxActivationPeriodExtensionMins: "/defaultMaxActivationPeriodExtensionMins"; readonly NotificationRecipients: "/notificationRecipients"; readonly NotificationTemplate: "/notificationTemplate"; readonly ApplyToFutureAssignments: "/applyToFutureAssignments"; }; export type JitAccessOperationRequestPathEnum = typeof JitAccessOperationRequestPathEnum[keyof typeof JitAccessOperationRequestPathEnum]; /** * @type JitAccessOperationRequestValue * New value. Type depends on **path**: arrays of strings for `/entitlementIds` and `/notificationRecipients`, integer for `*Mins` paths, string for `/notificationTemplate`, boolean for `/applyToFutureAssignments`. Use `null` when clearing nullable fields (for example `/notificationTemplate` or `*Mins` paths). * @export */ export type JitAccessOperationRequestValue = Array | boolean | number | string; /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const LocaleOrigin: { readonly Default: "DEFAULT"; readonly Request: "REQUEST"; }; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * JITAccessApi - axios parameter creator * @export */ export declare const JITAccessApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the tenant\'s current JIT activation policy configuration, including governed entitlement IDs, activation and extension time limits, default periods, notification settings, and whether the policy applies to future assignments. The tenant comes from the authenticated request context (not the URL). Use **configType** to select which configuration to read. Returns **404** if that configuration has not been stored yet. **User level:** POLICY_ADMIN (policy administrator). * @summary Get JIT activation policy configuration * @param {GetJitActivationConfigV1ConfigTypeEnum} configType Configuration kind to read. Only **policy** (JIT activation policy) is supported today. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getJitActivationConfigV1: (configType: GetJitActivationConfigV1ConfigTypeEnum, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Updates the tenant\'s JIT activation policy configuration by applying one or more **replace** operations (same shape as JSON Patch: **op**, **path**, **value**). Use this to change entitlement lists, max/default activation and extension durations, notification recipients or template, and the apply-to-future-assignments flag. The body must be a non-empty array. Only **replace** is supported; each **path** must be one of the values documented on the request item schema. The tenant is taken from the request context. **configType** selects which configuration to update. Returns **404** if the configuration does not exist, or **400** for an empty body, unknown **configType**, or invalid path/value. **User level:** POLICY_ADMIN (policy administrator). * @summary Update JIT activation policy configuration * @param {PatchJitActivationConfigV1ConfigTypeEnum} configType Configuration kind to update. Only **policy** (JIT activation policy) is supported today. * @param {Array} jitAccessOperationRequest * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchJitActivationConfigV1: (configType: PatchJitActivationConfigV1ConfigTypeEnum, jitAccessOperationRequest: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * JITAccessApi - functional programming interface * @export */ export declare const JITAccessApiFp: (configuration?: Configuration) => { /** * Returns the tenant\'s current JIT activation policy configuration, including governed entitlement IDs, activation and extension time limits, default periods, notification settings, and whether the policy applies to future assignments. The tenant comes from the authenticated request context (not the URL). Use **configType** to select which configuration to read. Returns **404** if that configuration has not been stored yet. **User level:** POLICY_ADMIN (policy administrator). * @summary Get JIT activation policy configuration * @param {GetJitActivationConfigV1ConfigTypeEnum} configType Configuration kind to read. Only **policy** (JIT activation policy) is supported today. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getJitActivationConfigV1(configType: GetJitActivationConfigV1ConfigTypeEnum, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the tenant\'s JIT activation policy configuration by applying one or more **replace** operations (same shape as JSON Patch: **op**, **path**, **value**). Use this to change entitlement lists, max/default activation and extension durations, notification recipients or template, and the apply-to-future-assignments flag. The body must be a non-empty array. Only **replace** is supported; each **path** must be one of the values documented on the request item schema. The tenant is taken from the request context. **configType** selects which configuration to update. Returns **404** if the configuration does not exist, or **400** for an empty body, unknown **configType**, or invalid path/value. **User level:** POLICY_ADMIN (policy administrator). * @summary Update JIT activation policy configuration * @param {PatchJitActivationConfigV1ConfigTypeEnum} configType Configuration kind to update. Only **policy** (JIT activation policy) is supported today. * @param {Array} jitAccessOperationRequest * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchJitActivationConfigV1(configType: PatchJitActivationConfigV1ConfigTypeEnum, jitAccessOperationRequest: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * JITAccessApi - factory interface * @export */ export declare const JITAccessApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the tenant\'s current JIT activation policy configuration, including governed entitlement IDs, activation and extension time limits, default periods, notification settings, and whether the policy applies to future assignments. The tenant comes from the authenticated request context (not the URL). Use **configType** to select which configuration to read. Returns **404** if that configuration has not been stored yet. **User level:** POLICY_ADMIN (policy administrator). * @summary Get JIT activation policy configuration * @param {JITAccessApiGetJitActivationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getJitActivationConfigV1(requestParameters: JITAccessApiGetJitActivationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Updates the tenant\'s JIT activation policy configuration by applying one or more **replace** operations (same shape as JSON Patch: **op**, **path**, **value**). Use this to change entitlement lists, max/default activation and extension durations, notification recipients or template, and the apply-to-future-assignments flag. The body must be a non-empty array. Only **replace** is supported; each **path** must be one of the values documented on the request item schema. The tenant is taken from the request context. **configType** selects which configuration to update. Returns **404** if the configuration does not exist, or **400** for an empty body, unknown **configType**, or invalid path/value. **User level:** POLICY_ADMIN (policy administrator). * @summary Update JIT activation policy configuration * @param {JITAccessApiPatchJitActivationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchJitActivationConfigV1(requestParameters: JITAccessApiPatchJitActivationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getJitActivationConfigV1 operation in JITAccessApi. * @export * @interface JITAccessApiGetJitActivationConfigV1Request */ export interface JITAccessApiGetJitActivationConfigV1Request { /** * Configuration kind to read. Only **policy** (JIT activation policy) is supported today. * @type {'policy'} * @memberof JITAccessApiGetJitActivationConfigV1 */ readonly configType: GetJitActivationConfigV1ConfigTypeEnum; /** * Use this header to enable this experimental API. * @type {string} * @memberof JITAccessApiGetJitActivationConfigV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for patchJitActivationConfigV1 operation in JITAccessApi. * @export * @interface JITAccessApiPatchJitActivationConfigV1Request */ export interface JITAccessApiPatchJitActivationConfigV1Request { /** * Configuration kind to update. Only **policy** (JIT activation policy) is supported today. * @type {'policy'} * @memberof JITAccessApiPatchJitActivationConfigV1 */ readonly configType: PatchJitActivationConfigV1ConfigTypeEnum; /** * * @type {Array} * @memberof JITAccessApiPatchJitActivationConfigV1 */ readonly jitAccessOperationRequest: Array; /** * Use this header to enable this experimental API. * @type {string} * @memberof JITAccessApiPatchJitActivationConfigV1 */ readonly xSailPointExperimental?: string; } /** * JITAccessApi - object-oriented interface * @export * @class JITAccessApi * @extends {BaseAPI} */ export declare class JITAccessApi extends BaseAPI { /** * Returns the tenant\'s current JIT activation policy configuration, including governed entitlement IDs, activation and extension time limits, default periods, notification settings, and whether the policy applies to future assignments. The tenant comes from the authenticated request context (not the URL). Use **configType** to select which configuration to read. Returns **404** if that configuration has not been stored yet. **User level:** POLICY_ADMIN (policy administrator). * @summary Get JIT activation policy configuration * @param {JITAccessApiGetJitActivationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof JITAccessApi */ getJitActivationConfigV1(requestParameters: JITAccessApiGetJitActivationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Updates the tenant\'s JIT activation policy configuration by applying one or more **replace** operations (same shape as JSON Patch: **op**, **path**, **value**). Use this to change entitlement lists, max/default activation and extension durations, notification recipients or template, and the apply-to-future-assignments flag. The body must be a non-empty array. Only **replace** is supported; each **path** must be one of the values documented on the request item schema. The tenant is taken from the request context. **configType** selects which configuration to update. Returns **404** if the configuration does not exist, or **400** for an empty body, unknown **configType**, or invalid path/value. **User level:** POLICY_ADMIN (policy administrator). * @summary Update JIT activation policy configuration * @param {JITAccessApiPatchJitActivationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof JITAccessApi */ patchJitActivationConfigV1(requestParameters: JITAccessApiPatchJitActivationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetJitActivationConfigV1ConfigTypeEnum: { readonly Policy: "policy"; }; export type GetJitActivationConfigV1ConfigTypeEnum = typeof GetJitActivationConfigV1ConfigTypeEnum[keyof typeof GetJitActivationConfigV1ConfigTypeEnum]; /** * @export */ export declare const PatchJitActivationConfigV1ConfigTypeEnum: { readonly Policy: "policy"; }; export type PatchJitActivationConfigV1ConfigTypeEnum = typeof PatchJitActivationConfigV1ConfigTypeEnum[keyof typeof PatchJitActivationConfigV1ConfigTypeEnum];