sailpoint-api-client 1.4.14 → 1.4.15

package/dist/v3/api.d.ts

@@ -281,6 +281,86 @@ export declare const AccessItemReviewedByTypeV3: {
     readonly Identity: "IDENTITY";
 };
 export type AccessItemReviewedByTypeV3 = typeof AccessItemReviewedByTypeV3[keyof typeof AccessItemReviewedByTypeV3];
+/**
+ * Metadata that describes an access item
+ * @export
+ * @interface AccessModelMetadata
+ */
+export interface AccessModelMetadata {
+    /**
+     * Unique identifier for the metadata type
+     * @type {string}
+     * @memberof AccessModelMetadata
+     */
+    'key'?: string;
+    /**
+     * Human readable name of the metadata type
+     * @type {string}
+     * @memberof AccessModelMetadata
+     */
+    'name'?: string;
+    /**
+     * Allows selecting multiple values
+     * @type {boolean}
+     * @memberof AccessModelMetadata
+     */
+    'multiselect'?: boolean;
+    /**
+     * The state of the metadata item
+     * @type {string}
+     * @memberof AccessModelMetadata
+     */
+    'status'?: string;
+    /**
+     * The type of the metadata item
+     * @type {string}
+     * @memberof AccessModelMetadata
+     */
+    'type'?: string;
+    /**
+     * The types of objects
+     * @type {Array<string>}
+     * @memberof AccessModelMetadata
+     */
+    'objectTypes'?: Array<string>;
+    /**
+     * Describes the metadata item
+     * @type {string}
+     * @memberof AccessModelMetadata
+     */
+    'description'?: string;
+    /**
+     * The value to assign to the metadata item
+     * @type {Array<AccessModelMetadataValuesInner>}
+     * @memberof AccessModelMetadata
+     */
+    'values'?: Array<AccessModelMetadataValuesInner>;
+}
+/**
+ * An individual value to assign to the metadata item
+ * @export
+ * @interface AccessModelMetadataValuesInner
+ */
+export interface AccessModelMetadataValuesInner {
+    /**
+     * The value to assign to the metdata item
+     * @type {string}
+     * @memberof AccessModelMetadataValuesInner
+     */
+    'value'?: string;
+    /**
+     * Display name of the value
+     * @type {string}
+     * @memberof AccessModelMetadataValuesInner
+     */
+    'name'?: string;
+    /**
+     * The status of the individual value
+     * @type {string}
+     * @memberof AccessModelMetadataValuesInner
+     */
+    'status'?: string;
+}
 /**
  * Access Profile
  * @export
@@ -1209,10 +1289,10 @@ export interface AccessRequestTracking {
     'requestedItemsDetails'?: Array<RequestedItemDetails>;
     /**
      * a hash representation of the access requested, useful for longer term tracking client side.
-     * @type {string}
+     * @type {number}
      * @memberof AccessRequestTracking
      */
-    'attributesHash'?: string;
+    'attributesHash'?: number;
     /**
      * a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids.
      * @type {Array<string>}
@@ -1387,7 +1467,7 @@ export interface Account {
      * @type {string}
      * @memberof Account
      */
-    'name': string;
+    'name': string | null;
     /**
      * Creation date of the Object
      * @type {string}
@@ -1444,10 +1524,10 @@ export interface Account {
     'isMachine'?: boolean;
     /**
      *
-     * @type {Recommendation}
+     * @type {AccountAllOfRecommendation}
      * @memberof Account
      */
-    'recommendation'?: Recommendation;
+    'recommendation'?: AccountAllOfRecommendation;
     /**
      * The account attributes that are aggregated
      * @type {{ [key: string]: any; }}
@@ -1518,16 +1598,16 @@ export interface Account {
     'hasEntitlements': boolean;
     /**
      *
-     * @type {BaseReferenceDto}
+     * @type {AccountAllOfIdentity}
      * @memberof Account
      */
-    'identity'?: BaseReferenceDto;
+    'identity'?: AccountAllOfIdentity;
     /**
      *
-     * @type {BaseReferenceDto}
+     * @type {AccountAllOfSourceOwner}
      * @memberof Account
      */
-    'sourceOwner'?: BaseReferenceDto;
+    'sourceOwner'?: AccountAllOfSourceOwner | null;
     /**
      * A string list containing the owning source\'s features
      * @type {string}
@@ -1542,10 +1622,10 @@ export interface Account {
     'origin'?: AccountOriginV3 | null;
     /**
      *
-     * @type {BaseReferenceDto}
+     * @type {AccountAllOfOwnerIdentity}
      * @memberof Account
      */
-    'ownerIdentity'?: BaseReferenceDto;
+    'ownerIdentity'?: AccountAllOfOwnerIdentity;
 }
 export declare const AccountOriginV3: {
     readonly Aggregated: "AGGREGATED";
@@ -2163,6 +2243,119 @@ export interface AccountActivitySearchedItem {
      */
     'sources'?: string;
 }
+/**
+ * The identity this account is correlated to
+ * @export
+ * @interface AccountAllOfIdentity
+ */
+export interface AccountAllOfIdentity {
+    /**
+     * The ID of the identity
+     * @type {string}
+     * @memberof AccountAllOfIdentity
+     */
+    'id'?: string;
+    /**
+     * The type of object being referenced
+     * @type {string}
+     * @memberof AccountAllOfIdentity
+     */
+    'type'?: AccountAllOfIdentityTypeV3;
+    /**
+     * display name of identity
+     * @type {string}
+     * @memberof AccountAllOfIdentity
+     */
+    'name'?: string;
+}
+export declare const AccountAllOfIdentityTypeV3: {
+    readonly Identity: "IDENTITY";
+};
+export type AccountAllOfIdentityTypeV3 = typeof AccountAllOfIdentityTypeV3[keyof typeof AccountAllOfIdentityTypeV3];
+/**
+ *
+ * @export
+ * @interface AccountAllOfOwnerIdentity
+ */
+export interface AccountAllOfOwnerIdentity {
+    /**
+     *
+     * @type {DtoType}
+     * @memberof AccountAllOfOwnerIdentity
+     */
+    'type'?: DtoType;
+    /**
+     * ID of the object to which this reference applies
+     * @type {string}
+     * @memberof AccountAllOfOwnerIdentity
+     */
+    'id'?: string;
+    /**
+     * Human-readable display name of the object to which this reference applies
+     * @type {string}
+     * @memberof AccountAllOfOwnerIdentity
+     */
+    'name'?: string;
+}
+/**
+ *
+ * @export
+ * @interface AccountAllOfRecommendation
+ */
+export interface AccountAllOfRecommendation {
+    /**
+     * Recommended type of account.
+     * @type {string}
+     * @memberof AccountAllOfRecommendation
+     */
+    'type': AccountAllOfRecommendationTypeV3;
+    /**
+     * Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria.
+     * @type {string}
+     * @memberof AccountAllOfRecommendation
+     */
+    'method': AccountAllOfRecommendationMethodV3;
+}
+export declare const AccountAllOfRecommendationTypeV3: {
+    readonly Human: "HUMAN";
+    readonly Machine: "MACHINE";
+};
+export type AccountAllOfRecommendationTypeV3 = typeof AccountAllOfRecommendationTypeV3[keyof typeof AccountAllOfRecommendationTypeV3];
+export declare const AccountAllOfRecommendationMethodV3: {
+    readonly Discovery: "DISCOVERY";
+    readonly Source: "SOURCE";
+    readonly Criteria: "CRITERIA";
+};
+export type AccountAllOfRecommendationMethodV3 = typeof AccountAllOfRecommendationMethodV3[keyof typeof AccountAllOfRecommendationMethodV3];
+/**
+ * The owner of the source this account belongs to.
+ * @export
+ * @interface AccountAllOfSourceOwner
+ */
+export interface AccountAllOfSourceOwner {
+    /**
+     * The ID of the identity
+     * @type {string}
+     * @memberof AccountAllOfSourceOwner
+     */
+    'id'?: string;
+    /**
+     * The type of object being referenced
+     * @type {string}
+     * @memberof AccountAllOfSourceOwner
+     */
+    'type'?: AccountAllOfSourceOwnerTypeV3;
+    /**
+     * display name of identity
+     * @type {string}
+     * @memberof AccountAllOfSourceOwner
+     */
+    'name'?: string;
+}
+export declare const AccountAllOfSourceOwnerTypeV3: {
+    readonly Identity: "IDENTITY";
+};
+export type AccountAllOfSourceOwnerTypeV3 = typeof AccountAllOfSourceOwnerTypeV3[keyof typeof AccountAllOfSourceOwnerTypeV3];
 /**
  *
  * @export
@@ -3407,43 +3600,43 @@ export interface AuthUser {
      * @type {string}
      * @memberof AuthUser
      */
-    'identificationNumber'?: string;
+    'identificationNumber'?: string | null;
     /**
      * Auth user\'s email.
      * @type {string}
      * @memberof AuthUser
      */
-    'email'?: string;
+    'email'?: string | null;
     /**
      * Auth user\'s phone number.
      * @type {string}
      * @memberof AuthUser
      */
-    'phone'?: string;
+    'phone'?: string | null;
     /**
      * Auth user\'s work phone number.
      * @type {string}
      * @memberof AuthUser
      */
-    'workPhone'?: string;
+    'workPhone'?: string | null;
     /**
      * Auth user\'s personal email.
      * @type {string}
      * @memberof AuthUser
      */
-    'personalEmail'?: string;
+    'personalEmail'?: string | null;
     /**
      * Auth user\'s first name.
      * @type {string}
      * @memberof AuthUser
      */
-    'firstname'?: string;
+    'firstname'?: string | null;
     /**
      * Auth user\'s last name.
      * @type {string}
      * @memberof AuthUser
      */
-    'lastname'?: string;
+    'lastname'?: string | null;
     /**
      * Auth user\'s name in displayed format.
      * @type {string}
@@ -3461,7 +3654,7 @@ export interface AuthUser {
      * @type {string}
      * @memberof AuthUser
      */
-    'lastPasswordChangeDate'?: string;
+    'lastPasswordChangeDate'?: string | null;
     /**
      * Timestamp of the last login (long type value).
      * @type {number}
@@ -3474,12 +3667,18 @@ export interface AuthUser {
      * @memberof AuthUser
      */
     'currentLoginTimestamp'?: number;
+    /**
+     * The date and time when the user was last unlocked.
+     * @type {string}
+     * @memberof AuthUser
+     */
+    'lastUnlockTimestamp'?: string | null;
     /**
      * Array of the auth user\'s capabilities.
      * @type {Array<string>}
      * @memberof AuthUser
      */
-    'capabilities'?: Array<AuthUserCapabilitiesV3>;
+    'capabilities'?: Array<AuthUserCapabilitiesV3> | null;
 }
 export declare const AuthUserCapabilitiesV3: {
     readonly CertAdmin: "CERT_ADMIN";
@@ -3948,7 +4147,7 @@ export interface BaseCommonDto {
      * @type {string}
      * @memberof BaseCommonDto
      */
-    'name': string;
+    'name': string | null;
     /**
      * Creation date of the Object
      * @type {string}
@@ -5258,7 +5457,7 @@ export interface Certification {
      * @type {string}
      * @memberof Certification
      */
-    'due'?: string;
+    'due'?: string | null;
     /**
      * The date the reviewer signed off on the Certification.
      * @type {string}
@@ -7364,7 +7563,7 @@ export interface Entitlement {
      * @type {string}
      * @memberof Entitlement
      */
-    'description'?: string;
+    'description'?: string | null;
     /**
      * True if the entitlement is privileged
      * @type {boolean}
@@ -7377,6 +7576,32 @@ export interface Entitlement {
      * @memberof Entitlement
      */
     'cloudGoverned'?: boolean;
+    /**
+     * True if the entitlement is able to be directly requested
+     * @type {boolean}
+     * @memberof Entitlement
+     */
+    'requestable'?: boolean;
+    /**
+     *
+     * @type {EntitlementOwner}
+     * @memberof Entitlement
+     */
+    'owner'?: EntitlementOwner | null;
+    /**
+     * A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated.
+     * @type {{ [key: string]: any; }}
+     * @memberof Entitlement
+     */
+    'manuallyUpdatedFields'?: {
+        [key: string]: any;
+    } | null;
+    /**
+     *
+     * @type {EntitlementAccessModelMetadata}
+     * @memberof Entitlement
+     */
+    'accessModelMetadata'?: EntitlementAccessModelMetadata;
     /**
      * Time when the entitlement was created
      * @type {string}
@@ -7416,6 +7641,19 @@ export interface Entitlement {
      */
     'directPermissions'?: Array<PermissionDto>;
 }
+/**
+ * Additional data to classify the entitlement
+ * @export
+ * @interface EntitlementAccessModelMetadata
+ */
+export interface EntitlementAccessModelMetadata {
+    /**
+     *
+     * @type {Array<AccessModelMetadata>}
+     * @memberof EntitlementAccessModelMetadata
+     */
+    'attributes'?: Array<AccessModelMetadata>;
+}
 /**
  * Entitlement
  * @export
@@ -7804,86 +8042,34 @@ export interface EntitlementDocuments {
     '_version'?: string;
 }
 /**
- *
+ * The identity that owns the entitlement
  * @export
- * @interface EntitlementDto
+ * @interface EntitlementOwner
  */
-export interface EntitlementDto {
+export interface EntitlementOwner {
     /**
-     * System-generated unique ID of the Object
+     * The identity ID
      * @type {string}
-     * @memberof EntitlementDto
+     * @memberof EntitlementOwner
      */
     'id'?: string;
     /**
-     * Name of the Object
-     * @type {string}
-     * @memberof EntitlementDto
-     */
-    'name': string;
-    /**
-     * Creation date of the Object
-     * @type {string}
-     * @memberof EntitlementDto
-     */
-    'created'?: string;
-    /**
-     * Last modification date of the Object
-     * @type {string}
-     * @memberof EntitlementDto
-     */
-    'modified'?: string;
-    /**
-     * Name of the entitlement attribute
-     * @type {string}
-     * @memberof EntitlementDto
-     */
-    'attribute'?: string;
-    /**
-     * Raw value of the entitlement
-     * @type {string}
-     * @memberof EntitlementDto
-     */
-    'value'?: string;
-    /**
-     * Entitlment description
+     * The type of object
      * @type {string}
-     * @memberof EntitlementDto
+     * @memberof EntitlementOwner
      */
-    'description'?: string;
-    /**
-     * Entitlement attributes
-     * @type {{ [key: string]: any; }}
-     * @memberof EntitlementDto
-     */
-    'attributes'?: {
-        [key: string]: any;
-    };
+    'type'?: EntitlementOwnerTypeV3;
     /**
-     * Schema objectType on the given application that maps to an Account Group
+     * The display name of the identity
      * @type {string}
-     * @memberof EntitlementDto
+     * @memberof EntitlementOwner
      */
-    'sourceSchemaObjectType'?: string;
-    /**
-     * Determines if this Entitlement is privileged.
-     * @type {boolean}
-     * @memberof EntitlementDto
-     */
-    'privileged'?: boolean;
-    /**
-     * Determines if this Entitlement is goverened in the cloud.
-     * @type {boolean}
-     * @memberof EntitlementDto
-     */
-    'cloudGoverned'?: boolean;
-    /**
-     *
-     * @type {EntitlementSource}
-     * @memberof EntitlementDto
-     */
-    'source'?: EntitlementSource;
+    'name'?: string;
 }
+export declare const EntitlementOwnerTypeV3: {
+    readonly Identity: "IDENTITY";
+};
+export type EntitlementOwnerTypeV3 = typeof EntitlementOwnerTypeV3[keyof typeof EntitlementOwnerTypeV3];
 /**
  * Entitlement including a specific set of access.
  * @export
@@ -9911,7 +10097,7 @@ export interface IdentityCertificationDto {
      * @type {string}
      * @memberof IdentityCertificationDto
      */
-    'due'?: string;
+    'due'?: string | null;
     /**
      * The date the reviewer signed off on the Certification.
      * @type {string}
@@ -10619,7 +10805,7 @@ export interface IdentityProfile {
      * @type {string}
      * @memberof IdentityProfile
      */
-    'name': string;
+    'name': string | null;
     /**
      * Creation date of the Object
      * @type {string}
@@ -11156,6 +11342,7 @@ export interface ImportObject {
     'name'?: string;
 }
 export declare const ImportObjectTypeV3: {
+    readonly ConnectorRule: "CONNECTOR_RULE";
     readonly IdentityObjectConfig: "IDENTITY_OBJECT_CONFIG";
     readonly IdentityProfile: "IDENTITY_PROFILE";
     readonly Rule: "RULE";
@@ -11463,7 +11650,7 @@ export interface LifecycleState {
      * @type {string}
      * @memberof LifecycleState
      */
-    'name': string;
+    'name': string | null;
     /**
      * Creation date of the Object
      * @type {string}
@@ -14976,6 +15163,14 @@ export interface PendingApproval {
      * @memberof PendingApproval
      */
     'sodViolationContext'?: SodViolationContextCheckCompleted | null;
+    /**
+     * Arbitrary key-value pairs, if any were included in the corresponding access request item
+     * @type {{ [key: string]: string; }}
+     * @memberof PendingApproval
+     */
+    'clientMetadata'?: {
+        [key: string]: string;
+    } | null;
 }
 /**
  * Enum represents action that is being processed on an approval.
@@ -16437,6 +16632,12 @@ export type RequestedItemDetailsTypeV3 = typeof RequestedItemDetailsTypeV3[keyof
  * @interface RequestedItemStatus
  */
 export interface RequestedItemStatus {
+    /**
+     * The ID of the access request.
+     * @type {string}
+     * @memberof RequestedItemStatus
+     */
+    'id'?: string;
     /**
      * Human-readable display name of the item being requested.
      * @type {string}
@@ -18500,7 +18701,7 @@ export interface Schedule {
      * @type {ScheduleMonths}
      * @memberof Schedule
      */
-    'months'?: ScheduleMonths;
+    'months'?: ScheduleMonths | null;
     /**
      *
      * @type {ScheduleDays}
@@ -18518,7 +18719,7 @@ export interface Schedule {
      * @type {string}
      * @memberof Schedule
      */
-    'expiration'?: string;
+    'expiration'?: string | null;
     /**
      * The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST.
      * @type {string}
@@ -18674,7 +18875,7 @@ export interface ScheduleDays {
      * @type {number}
      * @memberof ScheduleDays
      */
-    'interval'?: number;
+    'interval'?: number | null;
 }
 export declare const ScheduleDaysTypeV3: {
     readonly List: "LIST";
@@ -18704,7 +18905,7 @@ export interface ScheduleHours {
      * @type {number}
      * @memberof ScheduleHours
      */
-    'interval'?: number;
+    'interval'?: number | null;
 }
 export declare const ScheduleHoursTypeV3: {
     readonly List: "LIST";
@@ -19652,7 +19853,7 @@ export interface ServiceDeskIntegrationTemplateDto {
      * @type {string}
      * @memberof ServiceDeskIntegrationTemplateDto
      */
-    'name': string;
+    'name': string | null;
     /**
      * Creation date of the Object
      * @type {string}
@@ -25360,7 +25561,7 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
      * @param {*} [axiosOptions] Override http request option.
      * @throws {RequiredError}
      */
-    getAccountEntitlements(id: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementDto>>>;
+    getAccountEntitlements(id: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Entitlement>>>;
     /**
      * List accounts.
      * @summary Accounts List
@@ -25462,7 +25663,7 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
      * @param {*} [axiosOptions] Override http request option.
      * @throws {RequiredError}
      */
-    getAccountEntitlements(requestParameters: AccountsApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EntitlementDto>>;
+    getAccountEntitlements(requestParameters: AccountsApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Entitlement>>;
     /**
      * List accounts.
      * @summary Accounts List
@@ -25785,7 +25986,7 @@ export declare class AccountsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof AccountsApi
      */
-    getAccountEntitlements(requestParameters: AccountsApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementDto[], any>>;
+    getAccountEntitlements(requestParameters: AccountsApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Entitlement[], any>>;
     /**
      * List accounts.
      * @summary Accounts List
@@ -42909,10 +43110,11 @@ export declare const WorkItemsApiAxiosParamCreator: (configuration?: Configurati
      * This API completes a work item. Either an admin, or the owning/current user must make this request.
      * @summary Complete a Work Item
      * @param {string} id The ID of the work item
+     * @param {string | null} [body] Body is the request payload to create form definition request
      * @param {*} [axiosOptions] Override http request option.
      * @throws {RequiredError}
      */
-    completeWorkItem: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    completeWorkItem: (id: string, body?: string | null, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.
      * @summary Completed Work Items
@@ -43031,10 +43233,11 @@ export declare const WorkItemsApiFp: (configuration?: Configuration) => {
      * This API completes a work item. Either an admin, or the owning/current user must make this request.
      * @summary Complete a Work Item
      * @param {string} id The ID of the work item
+     * @param {string | null} [body] Body is the request payload to create form definition request
      * @param {*} [axiosOptions] Override http request option.
      * @throws {RequiredError}
      */
-    completeWorkItem(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkItems>>;
+    completeWorkItem(id: string, body?: string | null, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkItems>>;
     /**
      * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.
      * @summary Completed Work Items
@@ -43281,6 +43484,12 @@ export interface WorkItemsApiCompleteWorkItemRequest {
      * @memberof WorkItemsApiCompleteWorkItem
      */
     readonly id: string;
+    /**
+     * Body is the request payload to create form definition request
+     * @type {string}
+     * @memberof WorkItemsApiCompleteWorkItem
+     */
+    readonly body?: string | null;
 }
 /**
  * Request parameters for getCompletedWorkItems operation in WorkItemsApi.