@sailpoint/angular-sdk 0.0.11 → 0.0.13

package/types/sailpoint-angular-sdk-intelligence.d.ts

@@ -3,6 +3,161 @@ import { Observable } from 'rxjs';
 import * as i0 from '@angular/core';
 import { InjectionToken, ModuleWithProviders } from '@angular/core';
 
+/**
+ * Identity Security Cloud API - Intelligence
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Typed id and name reference for owners, machine identities, and authorized humans.
+ */
+interface Intelmachineentityref {
+    /**
+     * Reference type label from upstream (for example IDENTITY or MACHINE_IDENTITY).
+     */
+    type: string;
+    /**
+     * Referenced object identifier.
+     */
+    id: string;
+    /**
+     * Display name for the referenced identity or entity.
+     */
+    name: string;
+    /**
+     * Email for authorized human holders when available upstream.
+     */
+    email?: string;
+}
+
+/**
+ * Identity Security Cloud API - Intelligence
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface Intelmachinesourcewire {
+    /**
+     * Source identifier.
+     */
+    id: string;
+    /**
+     * Source display name.
+     */
+    name: string;
+    /**
+     * Source type label from upstream.
+     */
+    type: string;
+}
+
+/**
+ * Identity Security Cloud API - Intelligence
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Machine account row on the non-human identity aggregate accounts.items list. Every property in required is always present on the wire. Nullable object refs (source, machineIdentity, ownerIdentity) may be null. String fields may be empty when upstream has no value; booleans, timestamps, attributes, and connectorAttributes are always emitted (empty object when absent).
+ */
+interface Intelmachineaccountwire {
+    /**
+     * Unique account identifier in Identity Security Cloud.
+     */
+    id: string;
+    /**
+     * Account name on the correlated source.
+     */
+    name: string;
+    /**
+     * Native identifier on the source system.
+     */
+    nativeIdentity: string;
+    /**
+     * Source metadata for the machine account when present upstream.
+     */
+    source: Intelmachinesourcewire | null;
+    /**
+     * True when the account is enabled for use on the source.
+     */
+    enabled: boolean;
+    /**
+     * True when the account is locked on the source.
+     */
+    locked: boolean;
+    /**
+     * Reference to the parent machine identity when populated upstream.
+     */
+    machineIdentity: Intelmachineentityref | null;
+    /**
+     * Reference to the owning human identity when populated upstream.
+     */
+    ownerIdentity: Intelmachineentityref | null;
+    /**
+     * Free-text account description from the source.
+     */
+    description: string;
+    /**
+     * Account subtype label from upstream classification.
+     */
+    subtype: string;
+    /**
+     * Access type label for the account (for example account or entitlement).
+     */
+    accessType: string;
+    /**
+     * Environment label associated with the account.
+     */
+    environment: string;
+    /**
+     * Method used to classify the account as a machine account.
+     */
+    classificationMethod: string;
+    /**
+     * True when an administrator manually edited account attributes.
+     */
+    manuallyEdited: boolean;
+    /**
+     * True when an administrator manually correlated the account.
+     */
+    manuallyCorrelated: boolean;
+    /**
+     * True when the account holds one or more entitlements.
+     */
+    hasEntitlements: boolean;
+    /**
+     * Timestamp when the account record was created.
+     */
+    created: string;
+    /**
+     * Timestamp when the account record was last modified.
+     */
+    modified: string;
+    /**
+     * Extended account attributes from the source connector.
+     */
+    attributes: {
+        [key: string]: any;
+    };
+    /**
+     * Connector-specific attribute bag from upstream.
+     */
+    connectorAttributes: {
+        [key: string]: any;
+    };
+}
+
 /**
  * Identity Security Cloud API - Intelligence
  *
@@ -84,6 +239,40 @@ interface IntelAccessAccountWire {
     modified: string;
 }
 
+/**
+ * Identity Security Cloud API - Intelligence
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Accounts slice embedded in the aggregate identity response.
+ */
+interface IntelAccountsSlice {
+    /**
+     * First page of accounts for the identity.
+     */
+    items: Array<IntelAccessAccountWire>;
+    /**
+     * Total number of accounts for this identity; omitted when `items` is empty.
+     */
+    totalCount?: number;
+    /**
+     * Absolute URL to the next accounts page; present when totalCount exceeds the items returned on this page.
+     */
+    next?: string;
+}
+
+/**
+ * @type GetIntelIdentityAccountsV1200Response
+ * @export
+ */
+type GetIntelIdentityAccountsV1200Response = Array<Intelmachineaccountwire> | IntelAccountsSlice;
+
 /**
  * Identity Security Cloud API - Intelligence
  *
@@ -191,37 +380,6 @@ interface IntelOutlierAccessItem {
     extremelyRare: boolean;
 }
 
-/**
- * Identity Security Cloud API - Intelligence
- *
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- * Typed id and name reference for owners, machine identities, and authorized humans.
- */
-interface Intelmachineentityref {
-    /**
-     * Reference type label from upstream (for example IDENTITY or MACHINE_IDENTITY).
-     */
-    type: string;
-    /**
-     * Referenced object identifier.
-     */
-    id: string;
-    /**
-     * Display name for the referenced identity or entity.
-     */
-    name: string;
-    /**
-     * Email for authorized human holders when available upstream.
-     */
-    email?: string;
-}
-
 /**
  * Identity Security Cloud API - Intelligence
  *
@@ -338,139 +496,23 @@ interface Intelidentitygraphlink {
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-interface Intelmachinesourcewire {
-    /**
-     * Source identifier.
-     */
-    id: string;
-    /**
-     * Source display name.
-     */
-    name: string;
-    /**
-     * Source type label from upstream.
-     */
-    type: string;
-}
 
 /**
- * Identity Security Cloud API - Intelligence
- *
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
+ * Machine accounts embedded on the non-human identity aggregate (first page).
  */
-
-/**
- * Machine account row on the non-human identity aggregate accounts.items list. Every property in required is always present on the wire. Nullable object refs (source, machineIdentity, ownerIdentity) may be null. String fields may be empty when upstream has no value; booleans, timestamps, attributes, and connectorAttributes are always emitted (empty object when absent).
- */
-interface Intelmachineaccountwire {
-    /**
-     * Unique account identifier in Identity Security Cloud.
-     */
-    id: string;
-    /**
-     * Account name on the correlated source.
-     */
-    name: string;
-    /**
-     * Native identifier on the source system.
-     */
-    nativeIdentity: string;
-    /**
-     * Source metadata for the machine account when present upstream.
-     */
-    source: Intelmachinesourcewire | null;
-    /**
-     * True when the account is enabled for use on the source.
-     */
-    enabled: boolean;
-    /**
-     * True when the account is locked on the source.
-     */
-    locked: boolean;
-    /**
-     * Reference to the parent machine identity when populated upstream.
-     */
-    machineIdentity: Intelmachineentityref | null;
-    /**
-     * Reference to the owning human identity when populated upstream.
-     */
-    ownerIdentity: Intelmachineentityref | null;
-    /**
-     * Free-text account description from the source.
-     */
-    description: string;
-    /**
-     * Account subtype label from upstream classification.
-     */
-    subtype: string;
-    /**
-     * Access type label for the account (for example account or entitlement).
-     */
-    accessType: string;
-    /**
-     * Environment label associated with the account.
-     */
-    environment: string;
-    /**
-     * Method used to classify the account as a machine account.
-     */
-    classificationMethod: string;
-    /**
-     * True when an administrator manually edited account attributes.
-     */
-    manuallyEdited: boolean;
-    /**
-     * True when an administrator manually correlated the account.
-     */
-    manuallyCorrelated: boolean;
-    /**
-     * True when the account holds one or more entitlements.
-     */
-    hasEntitlements: boolean;
-    /**
-     * Timestamp when the account record was created.
-     */
-    created: string;
-    /**
-     * Timestamp when the account record was last modified.
-     */
-    modified: string;
+interface Intelmachineaccountsslice {
     /**
-     * Extended account attributes from the source connector.
+     * Machine accounts correlated to the non-human identity.
      */
-    attributes: {
-        [key: string]: any;
-    };
+    items: Array<Intelmachineaccountwire>;
     /**
-     * Connector-specific attribute bag from upstream.
+     * Correlated machine account count from aggregation; omitted when items is empty.
      */
-    connectorAttributes: {
-        [key: string]: any;
-    };
-}
-
-/**
- * Identity Security Cloud API - Intelligence
- *
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-/**
- * Correlated machine accounts embedded on the non-human identity aggregate. Returns the correlated account set on the wire today (account paging via child routes is not yet released).
- */
-interface Intelmachineaccountsslice {
+    totalCount?: number;
     /**
-     * Machine account rows correlated to the non-human identity.
+     * Next page URL when totalCount exceeds items returned. Includes isNHI=true.
      */
-    items: Array<Intelmachineaccountwire>;
+    next?: string;
 }
 
 /**
@@ -709,34 +751,6 @@ interface IntelPrivilegedAccessSlice {
     items: Array<IntelPrivilegedAccessItemWire>;
 }
 
-/**
- * Identity Security Cloud API - Intelligence
- *
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-/**
- * Accounts slice embedded in the aggregate identity response.
- */
-interface IntelAccountsSlice {
-    /**
-     * First page of accounts for the identity.
-     */
-    items: Array<IntelAccessAccountWire>;
-    /**
-     * Total number of accounts for this identity; omitted when `items` is empty.
-     */
-    totalCount?: number;
-    /**
-     * Absolute URL to the next accounts page; present when totalCount exceeds the items returned on this page.
-     */
-    next?: string;
-}
-
 /**
  * Identity Security Cloud API - Intelligence
  *
@@ -1384,6 +1398,8 @@ interface GetIntelIdentityAccountsV1RequestParams {
     offset?: number;
     /** If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;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. */
     count?: boolean;
+    /** NHI accounts when &#x60;true&#x60; (bare array). Human accounts when omitted or &#x60;false&#x60; (slice object).  */
+    isNHI?: boolean;
 }
 interface GetIntelIdentityCertificationHistoryV1RequestParams {
     /** Non-empty identity id path segment for Intelligence sub-resources. */
@@ -1450,7 +1466,7 @@ declare class IntelligenceService extends BaseService {
     }): Observable<HttpEvent<Responseactionaccepted>>;
     /**
      * Get identity by filter
-     * Requires tenant license idn:response-and-remediation.  **Authentication and data segmentation**  Intelligence forwards the caller JWT to downstream identity and search services (context client). Enriched results, including non-human identity resolution, are filtered to the caller\&#39;s Data Segmentation visibility.  **Caution:** Generic API Management API keys are not tied to a user identity. When Data Segmentation is enabled, API key authentication may fail or return incomplete data because downstream calls require a user context. Use a [personal access token](https://developer.sailpoint.com/docs/api/authentication/#generate-a-personal-access-token) or other user-scoped OAuth token. See [API keys](https://documentation.sailpoint.com/saas/help/common/api_keys.html) and [Data Segmentation](https://documentation.sailpoint.com/saas/help/segmentation/index.html).  Resolves exactly one identity using a single SCIM-style filters expression.  **Supported filters**  | Filter field | Lookup mode | Notes | |---|---|---| | id eq | Human (+ optional non-human identity when feature-flagged) | Resolves human identities by id; when non-human resolution is enabled, a parallel non-human lookup runs. If both match different identities, returns HTTP 409. | | email eq | Human only | Human identity lookup by email only. | | opaqueIdentifier eq | Non-human identity only | Parallel nativeIdentity eq on machine-identities and machine-accounts, then name-prefix fallback on machine-accounts. Requires feature flag ISCRR-1905_NHI_TYPE_MACHINE_FILTER_ENABLED; when disabled, returns HTTP 400. |  Single-clause filters only; composite and or expressions are rejected with HTTP 400.  **identityGraph deep link**  When the tenant has the idg:base license, Human and NHI aggregate responses may include &#x60;identityGraph.href&#x60;, a deep link into the Identity Graph UI for the resolved identity. Opening the link requires the **Identity Graph Read Only** user level. The link is omitted when the tenant lacks idg:base.  **Human envelope (type Human)**  Embeds the first page (10 items) of each enrichment slice. Each paged slice includes totalCount from upstream X-Total-Count when items is non-empty, and carries a next continuation URL when totalCount exceeds the items returned on this page. Slices are always present (empty uses items [] with no totalCount). privilegedAccess returns the full privileged-access result and never carries next or totalCount. When the tenant has idn:machine-identity-security, nonHumanIdentityOwnership is included with agents and applications categories; each category is a flat object with independently paged primaryOwned and secondaryOwned buckets, and optional message/reason when upstream ownership fetch fails for that category (reason UPSTREAM_UNAVAILABLE). When the tenant lacks that license, nonHumanIdentityOwnership is omitted. Continue ownership paging with GET .../non-human-identity-ownership/{category} and optional ownershipRole&#x3D;primary|secondary (defaults to primary). If any enrichment upstream fails, the whole request fails with HTTP 500, except outliers (omitted when the tenant lacks the IDA-outliers license) and nonHumanIdentityOwnership category-level degrade (aggregate still returns HTTP 200).  **Non-human identity envelope (type NHI)**  Returns flat non-human identity fields at the top level plus correlated machine accounts on the aggregate and a derived block (isOrphaned, authorizedHumanIdentities, blastRadiusSummary). Omits Human-only slices (privilegedAccess, outliers, accessHistory, nonHumanIdentityOwnership). Account paging via child routes is not yet released. Opaque prefix resolution that deduplicates to one parent identity returns HTTP 200 with matchConfidence partial; multiple distinct parent identities return HTTP 409 with IDC_IDENTITY_AMBIGUOUS and candidate id and displayName values.
+     * Requires tenant license idn:response-and-remediation.  **Caution:** When Data Segmentation is enabled, generic API Management API keys are not tied to a user identity and may fail or return incomplete data. Use a [personal access token](https://developer.sailpoint.com/docs/api/authentication/#generate-a-personal-access-token) or other user-scoped OAuth token. See [API keys](https://documentation.sailpoint.com/saas/help/common/api_keys.html) and [Data Segmentation](https://documentation.sailpoint.com/saas/help/segmentation/index.html).  Resolves exactly one identity using a single SCIM-style filters expression. Returns an enriched Human or non-human identity (NHI) envelope. Single-clause filters only; unsupported fields or operators return HTTP 400.
      * @param requestParameters
      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
      * @param reportProgress flag to report request and response progress.
@@ -1494,7 +1510,7 @@ declare class IntelligenceService extends BaseService {
     }): Observable<HttpEvent<Array<IntelAccessItemHistoryEvent>>>;
     /**
      * List identity accounts
-     * Continuation endpoint for a Human identity\&#39;s &#x60;accounts.next&#x60; link. Returns one page of account rows for the supplied limit and offset values. Pass &#x60;count&#x3D;true&#x60; to receive &#x60;X-Total-Count&#x60; (including &#x60;0&#x60; on empty pages). Not applicable to non-human identities (NHI accounts are returned on the NHI aggregate only). Requires tenant license idn:response-and-remediation.
+     * Continuation endpoint for &#x60;accounts.next&#x60;. Pass &#x60;count&#x3D;true&#x60; for &#x60;X-Total-Count&#x60;.  - Human (default): omit &#x60;isNHI&#x60; or set it to &#x60;false&#x60;. Slice object (&#x60;items&#x60;). - Non-human identity (NHI): set &#x60;isNHI&#x3D;true&#x60; (required for NHI aggregate &#x60;accounts.next&#x60; links). Bare JSON array.
      * @param requestParameters
      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
      * @param reportProgress flag to report request and response progress.
@@ -1503,17 +1519,17 @@ declare class IntelligenceService extends BaseService {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<Array<IntelAccessAccountWire>>;
+    }): Observable<GetIntelIdentityAccountsV1200Response>;
     getIntelIdentityAccountsV1(requestParameters: GetIntelIdentityAccountsV1RequestParams, observe?: 'response', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<HttpResponse<Array<IntelAccessAccountWire>>>;
+    }): Observable<HttpResponse<GetIntelIdentityAccountsV1200Response>>;
     getIntelIdentityAccountsV1(requestParameters: GetIntelIdentityAccountsV1RequestParams, observe?: 'events', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<HttpEvent<Array<IntelAccessAccountWire>>>;
+    }): Observable<HttpEvent<GetIntelIdentityAccountsV1200Response>>;
     /**
      * List identity certification history
      * Continuation endpoint for the parent response\&#39;s &#x60;accessHistory.certifications.next&#x60; link. Returns one page of certification history events for the supplied limit and offset values. Pass &#x60;count&#x3D;true&#x60; to receive &#x60;X-Total-Count&#x60; (including &#x60;0&#x60; on empty pages). Per-record decode failures are dropped server-side. Requires tenant license idn:response-and-remediation.  Not applicable to non-human identities.
@@ -1853,4 +1869,4 @@ declare class ApiModule {
 }
 
 export { APIS, ApiModule, BASE_PATH, COLLECTION_FORMATS, Configuration, IntelAccessItemHistoryEventEventTypeEnum, IntelCertificationHistoryEventEventTypeEnum, IntelIdentityAggregateSubtypeEnum, IntelIdentityAggregateTypeEnum, IntelIdentityNotFoundBodyDetailCodeEnum, IntelidentityambiguousbodyDetailCodeEnum, IntelidentitymachineaggregateMatchConfidenceEnum, IntelidentitymachineaggregateTypeEnum, IntelligenceService, IntelnonhumanidentityownershipcategoryReasonEnum, IntelprivilegelevelEffectiveEnum, LocaleOrigin, ResponseactionacceptedStatusEnum, ResponseactioncontextSourceEnum, ResponseactioncreaterequestOneOf1ActionTypeEnum, ResponseactioncreaterequestOneOfActionTypeEnum, ResponseactionstatusActionTypeEnum, ResponseactionstatusStatusEnum };
-export type { ConfigurationParameters, CreateResponseActionV1RequestParams, DataFormat, DataType, ErrorMessageDto, ErrorResponseDto, GetIdentityIntelligenceV1401Response, GetIdentityIntelligenceV1429Response, GetIdentityIntelligenceV1RequestParams, GetIntelIdentityAccessItemHistoryV1RequestParams, GetIntelIdentityAccountsV1RequestParams, GetIntelIdentityCertificationHistoryV1RequestParams, GetIntelIdentityNonHumanIdentityOwnershipV1RequestParams, GetIntelIdentityRareAccessV1RequestParams, GetResponseActionStatusV1RequestParams, IntelAccessAccountWire, IntelAccessHistory, IntelAccessHistoryAccessItemsSlice, IntelAccessHistoryCertificationsSlice, IntelAccessItemHistoryEvent, IntelAccessSourceWire, IntelAccountsSlice, IntelCertificationHistoryEvent, IntelIdentityAggregate, IntelIdentityNotFoundBody, IntelOutlierAccessItem, IntelOutliersSlice, IntelPrivilegedAccessItemWire, IntelPrivilegedAccessItemWireSource, IntelPrivilegedAccessSlice, IntelRareAccessSlice, Intelblastradiussummary, Intelidentityambiguousbody, Intelidentityambiguouscandidate, Intelidentityenvelope, Intelidentitygraphlink, Intelidentitymachineaggregate, Intelmachineaccountsslice, Intelmachineaccountwire, Intelmachinederived, Intelmachineentityref, Intelmachineidentityowners, Intelmachinesourcewire, Intelmachineuserentitlement, Intelnonhumanidentityownedslice, Intelnonhumanidentityownership, Intelnonhumanidentityownershipcategory, Intelnonhumanidentityownershipitem, Intelprivilegelevel, Param, ParamLocation, ParamStyle, Responseactionaccepted, Responseactioncontext, Responseactioncreaterequest, ResponseactioncreaterequestOneOf, ResponseactioncreaterequestOneOf1, Responseactionstatus, StandardDataFormat, StandardDataType, StandardParamStyle };
+export type { ConfigurationParameters, CreateResponseActionV1RequestParams, DataFormat, DataType, ErrorMessageDto, ErrorResponseDto, GetIdentityIntelligenceV1401Response, GetIdentityIntelligenceV1429Response, GetIdentityIntelligenceV1RequestParams, GetIntelIdentityAccessItemHistoryV1RequestParams, GetIntelIdentityAccountsV1200Response, GetIntelIdentityAccountsV1RequestParams, GetIntelIdentityCertificationHistoryV1RequestParams, GetIntelIdentityNonHumanIdentityOwnershipV1RequestParams, GetIntelIdentityRareAccessV1RequestParams, GetResponseActionStatusV1RequestParams, IntelAccessAccountWire, IntelAccessHistory, IntelAccessHistoryAccessItemsSlice, IntelAccessHistoryCertificationsSlice, IntelAccessItemHistoryEvent, IntelAccessSourceWire, IntelAccountsSlice, IntelCertificationHistoryEvent, IntelIdentityAggregate, IntelIdentityNotFoundBody, IntelOutlierAccessItem, IntelOutliersSlice, IntelPrivilegedAccessItemWire, IntelPrivilegedAccessItemWireSource, IntelPrivilegedAccessSlice, IntelRareAccessSlice, Intelblastradiussummary, Intelidentityambiguousbody, Intelidentityambiguouscandidate, Intelidentityenvelope, Intelidentitygraphlink, Intelidentitymachineaggregate, Intelmachineaccountsslice, Intelmachineaccountwire, Intelmachinederived, Intelmachineentityref, Intelmachineidentityowners, Intelmachinesourcewire, Intelmachineuserentitlement, Intelnonhumanidentityownedslice, Intelnonhumanidentityownership, Intelnonhumanidentityownershipcategory, Intelnonhumanidentityownershipitem, Intelprivilegelevel, Param, ParamLocation, ParamStyle, Responseactionaccepted, Responseactioncontext, Responseactioncreaterequest, ResponseactioncreaterequestOneOf, ResponseactioncreaterequestOneOf1, Responseactionstatus, StandardDataFormat, StandardDataType, StandardParamStyle };