@sailpoint/api-client 2.2.37 → 2.2.39

package/dist/data_access_security/api.d.ts

@@ -441,19 +441,19 @@ export type CrawlResourcesSizesOptions = typeof CrawlResourcesSizesOptions[keyof
 /**
  *
  * @export
- * @interface CreateIdentityCollectorV1200Response
+ * @interface CreateIdentityCollectorV1201Response
  */
-export interface CreateIdentityCollectorV1200Response {
+export interface CreateIdentityCollectorV1201Response {
     /**
      * The unique identifier of the created identity collector.
      * @type {number}
-     * @memberof CreateIdentityCollectorV1200Response
+     * @memberof CreateIdentityCollectorV1201Response
      */
     'id'?: number;
     /**
      * The display name of the created identity collector.
      * @type {string}
-     * @memberof CreateIdentityCollectorV1200Response
+     * @memberof CreateIdentityCollectorV1201Response
      */
     'name'?: string;
 }
@@ -846,7 +846,7 @@ export interface Identitycollectorcollectionsettings {
      */
     'properties': Array<string>;
     /**
-     * Maps source attributes to data dictionary fields and DAS custom field slots. Each `sourceAttributeName` must be either a built-in attribute for the identity collector type or listed in `properties`. Use an empty array when no dynamic field mappings are configured.
+     * Maps source attributes to data dictionary fields and DAS custom field slots. The same `sourceAttributeName` may be mapped to multiple dictionary fields. Each `sourceAttributeName` must be either a built-in attribute for the identity collector type or listed in `properties`. Use an empty array when no dynamic field mappings are configured.
      * @type {Array<Identitycollectorfieldmapping>}
      * @memberof Identitycollectorcollectionsettings
      */
@@ -1001,6 +1001,38 @@ export interface Identitycollectorlistitem {
      */
     'groups'?: Identitycollectorcollectionsettings;
 }
+/**
+ * A public identity collector type and the ISC `connectorName` values the UI should use when querying `GET /v3/sources` for sources that can back that type.
+ * @export
+ * @interface Identitycollectortype
+ */
+export interface Identitycollectortype {
+    /**
+     * Identity collector type display name. Matches the `type` values returned by list and used by create/update metadata. Base types only (for example `Box`, not `Box SaaS`).
+     * @type {string}
+     * @memberof Identitycollectortype
+     */
+    'type': string;
+    /**
+     * Exact ISC `connectorName` values to use in `GET /v3/sources` filters (`connectorName eq \"...\"`). These are not always equal to `type` (for example Google Drive maps to `G Suite` and `Google Workspace SaaS`).
+     * @type {Array<string>}
+     * @memberof Identitycollectortype
+     */
+    'iscConnectorNames': Array<string>;
+}
+/**
+ * Public identity collector types available for discovery and create flows.
+ * @export
+ * @interface Identitycollectortypesresponse
+ */
+export interface Identitycollectortypesresponse {
+    /**
+     * Enabled public identity collector types. Flagged types (Snowflake, Databricks, Atlassian Suite) are omitted when their feature flags are disabled.
+     * @type {Array<Identitycollectortype>}
+     * @memberof Identitycollectortypesresponse
+     */
+    'types': Array<Identitycollectortype>;
+}
 /**
  *
  * @export
@@ -1624,7 +1656,7 @@ export declare const DataAccessSecurityApiAxiosParamCreator: (configuration?: Co
      */
     getIdentityCollectorBuiltinPropertiesV1: (filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns the public identity collector type display names exposed for metadata and UI discovery. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed here; the identity collector type is derived from `sourceId` when creating an identity collector. Existing identity collectors may still report SaaS variant types in list and update responses.  Pagination is not supported for this endpoint; the full set of public types is always returned.
+     * Returns the public identity collector types exposed for metadata and UI discovery, including the ISC `connectorName` values to use when listing sources for each type. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed as separate types; create derives the identity collector type from `sourceId`. Existing identity collectors may still report SaaS variant types in list and update responses.  Flagged types (Snowflake, Databricks, Atlassian Suite) are included only when the corresponding tenant feature flag is enabled.  Pagination is not supported for this endpoint; the full set of enabled public types is always returned.
      * @summary List identity collector types
      * @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 {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.
@@ -1783,7 +1815,7 @@ export declare const DataAccessSecurityApiFp: (configuration?: Configuration) =>
      * @param {*} [axiosOptions] Override http request option.
      * @throws {RequiredError}
      */
-    createIdentityCollectorV1(createidentitycollectorrequest: Createidentitycollectorrequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateIdentityCollectorV1200Response>>;
+    createIdentityCollectorV1(createidentitycollectorrequest: Createidentitycollectorrequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateIdentityCollectorV1201Response>>;
     /**
      *
      * @summary Create a new schedule.
@@ -1905,14 +1937,14 @@ export declare const DataAccessSecurityApiFp: (configuration?: Configuration) =>
      */
     getIdentityCollectorBuiltinPropertiesV1(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Identitycollectorbuiltinpropertiesresponse>>;
     /**
-     * Returns the public identity collector type display names exposed for metadata and UI discovery. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed here; the identity collector type is derived from `sourceId` when creating an identity collector. Existing identity collectors may still report SaaS variant types in list and update responses.  Pagination is not supported for this endpoint; the full set of public types is always returned.
+     * Returns the public identity collector types exposed for metadata and UI discovery, including the ISC `connectorName` values to use when listing sources for each type. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed as separate types; create derives the identity collector type from `sourceId`. Existing identity collectors may still report SaaS variant types in list and update responses.  Flagged types (Snowflake, Databricks, Atlassian Suite) are included only when the corresponding tenant feature flag is enabled.  Pagination is not supported for this endpoint; the full set of enabled public types is always returned.
      * @summary List identity collector types
      * @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 {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 {*} [axiosOptions] Override http request option.
      * @throws {RequiredError}
      */
-    getIdentityCollectorTypesV1(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
+    getIdentityCollectorTypesV1(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Identitycollectortypesresponse>>;
     /**
      *
      * @summary Retrieve owners per application.
@@ -2064,7 +2096,7 @@ export declare const DataAccessSecurityApiFactory: (configuration?: Configuratio
      * @param {*} [axiosOptions] Override http request option.
      * @throws {RequiredError}
      */
-    createIdentityCollectorV1(requestParameters: DataAccessSecurityApiCreateIdentityCollectorV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<CreateIdentityCollectorV1200Response>;
+    createIdentityCollectorV1(requestParameters: DataAccessSecurityApiCreateIdentityCollectorV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<CreateIdentityCollectorV1201Response>;
     /**
      *
      * @summary Create a new schedule.
@@ -2178,13 +2210,13 @@ export declare const DataAccessSecurityApiFactory: (configuration?: Configuratio
      */
     getIdentityCollectorBuiltinPropertiesV1(requestParameters?: DataAccessSecurityApiGetIdentityCollectorBuiltinPropertiesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Identitycollectorbuiltinpropertiesresponse>;
     /**
-     * Returns the public identity collector type display names exposed for metadata and UI discovery. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed here; the identity collector type is derived from `sourceId` when creating an identity collector. Existing identity collectors may still report SaaS variant types in list and update responses.  Pagination is not supported for this endpoint; the full set of public types is always returned.
+     * Returns the public identity collector types exposed for metadata and UI discovery, including the ISC `connectorName` values to use when listing sources for each type. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed as separate types; create derives the identity collector type from `sourceId`. Existing identity collectors may still report SaaS variant types in list and update responses.  Flagged types (Snowflake, Databricks, Atlassian Suite) are included only when the corresponding tenant feature flag is enabled.  Pagination is not supported for this endpoint; the full set of enabled public types is always returned.
      * @summary List identity collector types
      * @param {DataAccessSecurityApiGetIdentityCollectorTypesV1Request} requestParameters Request parameters.
      * @param {*} [axiosOptions] Override http request option.
      * @throws {RequiredError}
      */
-    getIdentityCollectorTypesV1(requestParameters?: DataAccessSecurityApiGetIdentityCollectorTypesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
+    getIdentityCollectorTypesV1(requestParameters?: DataAccessSecurityApiGetIdentityCollectorTypesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Identitycollectortypesresponse>;
     /**
      *
      * @summary Retrieve owners per application.
@@ -2889,7 +2921,7 @@ export declare class DataAccessSecurityApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof DataAccessSecurityApi
      */
-    createIdentityCollectorV1(requestParameters: DataAccessSecurityApiCreateIdentityCollectorV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateIdentityCollectorV1200Response, any>>;
+    createIdentityCollectorV1(requestParameters: DataAccessSecurityApiCreateIdentityCollectorV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateIdentityCollectorV1201Response, any>>;
     /**
      *
      * @summary Create a new schedule.
@@ -3017,14 +3049,14 @@ export declare class DataAccessSecurityApi extends BaseAPI {
      */
     getIdentityCollectorBuiltinPropertiesV1(requestParameters?: DataAccessSecurityApiGetIdentityCollectorBuiltinPropertiesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Identitycollectorbuiltinpropertiesresponse, any>>;
     /**
-     * Returns the public identity collector type display names exposed for metadata and UI discovery. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed here; the identity collector type is derived from `sourceId` when creating an identity collector. Existing identity collectors may still report SaaS variant types in list and update responses.  Pagination is not supported for this endpoint; the full set of public types is always returned.
+     * Returns the public identity collector types exposed for metadata and UI discovery, including the ISC `connectorName` values to use when listing sources for each type. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed as separate types; create derives the identity collector type from `sourceId`. Existing identity collectors may still report SaaS variant types in list and update responses.  Flagged types (Snowflake, Databricks, Atlassian Suite) are included only when the corresponding tenant feature flag is enabled.  Pagination is not supported for this endpoint; the full set of enabled public types is always returned.
      * @summary List identity collector types
      * @param {DataAccessSecurityApiGetIdentityCollectorTypesV1Request} requestParameters Request parameters.
      * @param {*} [axiosOptions] Override http request option.
      * @throws {RequiredError}
      * @memberof DataAccessSecurityApi
      */
-    getIdentityCollectorTypesV1(requestParameters?: DataAccessSecurityApiGetIdentityCollectorTypesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
+    getIdentityCollectorTypesV1(requestParameters?: DataAccessSecurityApiGetIdentityCollectorTypesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Identitycollectortypesresponse, any>>;
     /**
      *
      * @summary Retrieve owners per application.

package/dist/data_access_security/api.js

@@ -862,7 +862,7 @@ var DataAccessSecurityApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * Returns the public identity collector type display names exposed for metadata and UI discovery. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed here; the identity collector type is derived from `sourceId` when creating an identity collector. Existing identity collectors may still report SaaS variant types in list and update responses.  Pagination is not supported for this endpoint; the full set of public types is always returned.
+         * Returns the public identity collector types exposed for metadata and UI discovery, including the ISC `connectorName` values to use when listing sources for each type. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed as separate types; create derives the identity collector type from `sourceId`. Existing identity collectors may still report SaaS variant types in list and update responses.  Flagged types (Snowflake, Databricks, Atlassian Suite) are included only when the corresponding tenant feature flag is enabled.  Pagination is not supported for this endpoint; the full set of enabled public types is always returned.
          * @summary List identity collector types
          * @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 {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.
@@ -1803,7 +1803,7 @@ var DataAccessSecurityApiFp = function (configuration) {
             });
         },
         /**
-         * Returns the public identity collector type display names exposed for metadata and UI discovery. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed here; the identity collector type is derived from `sourceId` when creating an identity collector. Existing identity collectors may still report SaaS variant types in list and update responses.  Pagination is not supported for this endpoint; the full set of public types is always returned.
+         * Returns the public identity collector types exposed for metadata and UI discovery, including the ISC `connectorName` values to use when listing sources for each type. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed as separate types; create derives the identity collector type from `sourceId`. Existing identity collectors may still report SaaS variant types in list and update responses.  Flagged types (Snowflake, Databricks, Atlassian Suite) are included only when the corresponding tenant feature flag is enabled.  Pagination is not supported for this endpoint; the full set of enabled public types is always returned.
          * @summary List identity collector types
          * @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 {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.
@@ -2313,7 +2313,7 @@ var DataAccessSecurityApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getIdentityCollectorBuiltinPropertiesV1(requestParameters.filters, axiosOptions).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * Returns the public identity collector type display names exposed for metadata and UI discovery. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed here; the identity collector type is derived from `sourceId` when creating an identity collector. Existing identity collectors may still report SaaS variant types in list and update responses.  Pagination is not supported for this endpoint; the full set of public types is always returned.
+         * Returns the public identity collector types exposed for metadata and UI discovery, including the ISC `connectorName` values to use when listing sources for each type. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed as separate types; create derives the identity collector type from `sourceId`. Existing identity collectors may still report SaaS variant types in list and update responses.  Flagged types (Snowflake, Databricks, Atlassian Suite) are included only when the corresponding tenant feature flag is enabled.  Pagination is not supported for this endpoint; the full set of enabled public types is always returned.
          * @summary List identity collector types
          * @param {DataAccessSecurityApiGetIdentityCollectorTypesV1Request} requestParameters Request parameters.
          * @param {*} [axiosOptions] Override http request option.
@@ -2680,7 +2680,7 @@ var DataAccessSecurityApi = /** @class */ (function (_super) {
         return (0, exports.DataAccessSecurityApiFp)(this.configuration).getIdentityCollectorBuiltinPropertiesV1(requestParameters.filters, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * Returns the public identity collector type display names exposed for metadata and UI discovery. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed here; the identity collector type is derived from `sourceId` when creating an identity collector. Existing identity collectors may still report SaaS variant types in list and update responses.  Pagination is not supported for this endpoint; the full set of public types is always returned.
+     * Returns the public identity collector types exposed for metadata and UI discovery, including the ISC `connectorName` values to use when listing sources for each type. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed as separate types; create derives the identity collector type from `sourceId`. Existing identity collectors may still report SaaS variant types in list and update responses.  Flagged types (Snowflake, Databricks, Atlassian Suite) are included only when the corresponding tenant feature flag is enabled.  Pagination is not supported for this endpoint; the full set of enabled public types is always returned.
      * @summary List identity collector types
      * @param {DataAccessSecurityApiGetIdentityCollectorTypesV1Request} requestParameters Request parameters.
      * @param {*} [axiosOptions] Override http request option.