@sailpoint/angular-sdk 0.0.32 → 0.0.33

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

@@ -3,6 +3,205 @@ import { Observable } from 'rxjs';
 import * as i0 from '@angular/core';
 import { InjectionToken, ModuleWithProviders } from '@angular/core';
 
+/**
+ * Identity Security Cloud API - Public Identities
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * @type PublicIdentitiesTextQueryTermsInner
+ * @export
+ */
+type PublicIdentitiesTextQueryTermsInner = boolean | string;
+
+/**
+ * Identity Security Cloud API - Public Identities
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Text query clause used inside a TEXT composite entry.
+ */
+interface PublicIdentitiesTextQuery {
+    /**
+     * Attribute keys to search. Base keys must match GET /public-identities/v2/visible-attributes (defaultAttributes + configuredAttributes). Optional \"attributes.\" prefix and/or \".exact\" suffix (e.g. email, attributes.email, email.exact, attributes.email.exact).
+     */
+    fields: Array<string>;
+    /**
+     * Search terms. Each value must be a non-blank string or a JSON boolean.
+     */
+    terms: Array<PublicIdentitiesTextQueryTermsInner>;
+    /**
+     * When true, terms/fields are OR\'d within this text query. Optional for normal search clauses. The mandatory ACTIVE identityState gate entry must set this to false.
+     */
+    matchAny?: boolean;
+    /**
+     * When true, matches substrings. Optional for normal search clauses. The mandatory ACTIVE identityState gate entry must set this to false.
+     */
+    contains?: boolean;
+    /**
+     * When true, applies strict matching. Optional for normal search clauses. The mandatory ACTIVE identityState gate entry must set this to true.
+     */
+    strict?: boolean;
+}
+
+/**
+ * Identity Security Cloud API - Public Identities
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * A COMPOSITE query entry that contains a TEXT query.
+ */
+interface PublicIdentitiesTextEntry {
+    /**
+     * Entry type discriminator. Must be TEXT for text query entries.
+     */
+    queryType: PublicIdentitiesTextEntryQueryTypeEnum;
+    /**
+     * Text query clause for this TEXT entry.
+     */
+    textQuery: PublicIdentitiesTextQuery;
+}
+declare enum PublicIdentitiesTextEntryQueryTypeEnum {
+    Text = "TEXT"
+}
+
+/**
+ * Identity Security Cloud API - Public Identities
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Query set nested inside a COMPOSITE entry. TEXT entries combined with AND (matchAny false) or OR (matchAny true).
+ */
+interface PublicIdentitiesNestedQuerySet {
+    /**
+     * When true, entries are OR\'d; when false, entries are AND\'d.
+     */
+    matchAny: boolean;
+    /**
+     * One or more TEXT entries.
+     */
+    entries: Array<PublicIdentitiesTextEntry>;
+}
+
+/**
+ * Identity Security Cloud API - Public Identities
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * A COMPOSITE query entry that nests another querySet.
+ */
+interface PublicIdentitiesNestedCompositeEntry {
+    /**
+     * Entry type discriminator. Must be COMPOSITE for nested query sets.
+     */
+    queryType: PublicIdentitiesNestedCompositeEntryQueryTypeEnum;
+    /**
+     * Nested query set for this COMPOSITE entry.
+     */
+    querySet: PublicIdentitiesNestedQuerySet;
+}
+declare enum PublicIdentitiesNestedCompositeEntryQueryTypeEnum {
+    Composite = "COMPOSITE"
+}
+
+/**
+ * A querySet entry that is either a TEXT clause or a nested COMPOSITE querySet.
+ */
+/**
+ * @type PublicIdentitiesCompositeEntry
+ * A querySet entry that is either a TEXT clause or a nested COMPOSITE querySet.
+ * @export
+ */
+type PublicIdentitiesCompositeEntry = PublicIdentitiesNestedCompositeEntry | PublicIdentitiesTextEntry;
+
+/**
+ * Identity Security Cloud API - Public Identities
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+interface PublicIdentitiesSearchRequestQuerySet {
+    /**
+     * When true, entries are OR\'d; when false, entries are AND\'d.
+     */
+    matchAny: boolean;
+    /**
+     * One or more TEXT or nested COMPOSITE entries.
+     */
+    entries: Array<PublicIdentitiesCompositeEntry>;
+}
+
+/**
+ * Identity Security Cloud API - Public Identities
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * COMPOSITE search request for public identities. Root querySet must use matchAny false (AND). The first entries item must be the ACTIVE identityState TEXT gate; identityState may not appear elsewhere in the query tree.
+ */
+interface PublicIdentitiesSearchRequest {
+    /**
+     * Search query type. Must be COMPOSITE.
+     */
+    queryType: PublicIdentitiesSearchRequestQueryTypeEnum;
+    /**
+     * Search indices. Must be exactly [\"identities\"].
+     */
+    indices: Array<PublicIdentitiesSearchRequestIndicesEnum>;
+    /**
+     * Must be false for public identities search.
+     */
+    includeNested: boolean;
+    /**
+     * Optional attribute keys to sort by. Base keys must match those returned by GET /public-identities/v2/visible-attributes (defaultAttributes + configuredAttributes). Optional \"attributes.\" prefix and/or \".exact\" suffix.
+     */
+    sort?: Array<string>;
+    querySet: PublicIdentitiesSearchRequestQuerySet;
+}
+declare enum PublicIdentitiesSearchRequestQueryTypeEnum {
+    Composite = "COMPOSITE"
+}
+declare enum PublicIdentitiesSearchRequestIndicesEnum {
+    Identities = "identities"
+}
+
 /**
  * Identity Security Cloud API - Public Identities
  *
@@ -146,6 +345,135 @@ declare enum PublicIdentityIdentityStateEnum {
     InactiveLongTerm = "INACTIVE_LONG_TERM"
 }
 
+/**
+ * Identity Security Cloud API - Public Identities
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Manager reference for a public identity search result
+ */
+interface PublicIdentityV2Manager {
+    /**
+     * Manager identity id
+     */
+    id: string | null;
+    /**
+     * Manager alias / technical name
+     */
+    name: string | null;
+    /**
+     * Manager display name. Null when absent from the search hit.
+     */
+    displayName: string | null;
+}
+
+/**
+ * Identity Security Cloud API - Public Identities
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Projected public identity returned by POST /public-identities/v2/search. Root fields are always present (null when unavailable). attributes contains only keys from GET /public-identities/v2/visible-attributes configuredAttributes.
+ */
+interface PublicIdentityV2 {
+    /**
+     * Identity id
+     */
+    id: string | null;
+    /**
+     * Alternate unique identifier for the identity (alias / search field name).
+     */
+    name: string | null;
+    /**
+     * Human-readable display name of the identity.
+     */
+    displayName: string | null;
+    /**
+     * Email address of identity.
+     */
+    email: string | null;
+    /**
+     * The current state of the identity, which determines how Identity Security Cloud interacts with the identity.
+     */
+    identityState: PublicIdentityV2IdentityStateEnum | null;
+    /**
+     * The lifecycle status for the identity
+     */
+    cloudLifecycleState: string | null;
+    /**
+     * Manager of this identity, or null when none
+     */
+    manager: PublicIdentityV2Manager | null;
+    /**
+     * Configured public identity attributes only (from visible-attributes configuredAttributes). Missing keys are omitted; present null values are returned as null.
+     */
+    attributes: {
+        [key: string]: string | null;
+    };
+}
+declare enum PublicIdentityV2IdentityStateEnum {
+    Active = "ACTIVE",
+    InactiveShortTerm = "INACTIVE_SHORT_TERM",
+    InactiveLongTerm = "INACTIVE_LONG_TERM"
+}
+
+/**
+ * Identity Security Cloud API - Public Identities
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Maps an identity attribute key to its display name.
+ */
+interface PublicIdentityAttributeConfig {
+    /**
+     * Attribute / search field key (e.g. email, manager.displayName).
+     */
+    key: string;
+    /**
+     * Human-readable display name for the attribute.
+     */
+    name: string;
+}
+
+/**
+ * Identity Security Cloud API - Public Identities
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Default and configured identity attribute keys with display names exposed by the public identities API.
+ */
+interface PublicIdentityVisibleAttributes {
+    /**
+     * Always-available public-identity field keys for search and sort. Fixed platform list. `key` is the search field name; `name` is the display label.
+     */
+    defaultAttributes: Array<PublicIdentityAttributeConfig>;
+    /**
+     * Tenant-configured public attributes from public-identities config (same source as public-identities-config). These keys are also allowed in search/sort and appear under `attributes` on search results.
+     */
+    configuredAttributes: Array<PublicIdentityAttributeConfig>;
+}
+
 /**
  * Standard parameter styles defined by OpenAPI spec
  */
@@ -314,6 +642,21 @@ interface GetPublicIdentitiesV1RequestParams {
     /** 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: **name** */
     sorters?: string;
 }
+interface GetPublicIdentitiesVisibleAttributesV2RequestParams {
+    /** Use this header to enable this experimental API. */
+    xSailPointExperimental?: string;
+}
+interface SearchPublicIdentitiesV2RequestParams {
+    publicIdentitiesSearchRequest: PublicIdentitiesSearchRequest;
+    /** Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. */
+    limit?: number;
+    /** 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. */
+    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;
+    /** Use this header to enable this experimental API. */
+    xSailPointExperimental?: string;
+}
 declare class PublicIdentitiesService extends BaseService {
     protected httpClient: HttpClient;
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
@@ -339,6 +682,50 @@ declare class PublicIdentitiesService extends BaseService {
         context?: HttpContext;
         transferCache?: boolean;
     }): Observable<HttpEvent<Array<PublicIdentity>>>;
+    /**
+     * Get public identity visible attributes
+     * Returns the default and configured identity attribute keys (with display names) that are allowed for public-identity search and projection. Call this before POST /public-identities/v2/search to learn which field keys are valid in query fields and sort.  Any authenticated user with the default scope can call this endpoint.
+     * @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.
+     */
+    getPublicIdentitiesVisibleAttributesV2(requestParameters?: GetPublicIdentitiesVisibleAttributesV2RequestParams, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<PublicIdentityVisibleAttributes>;
+    getPublicIdentitiesVisibleAttributesV2(requestParameters?: GetPublicIdentitiesVisibleAttributesV2RequestParams, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<PublicIdentityVisibleAttributes>>;
+    getPublicIdentitiesVisibleAttributesV2(requestParameters?: GetPublicIdentitiesVisibleAttributesV2RequestParams, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<PublicIdentityVisibleAttributes>>;
+    /**
+     * Search public identities
+     * Search public identities using a composite query and return matching records.  The root query set combines criteria with AND and must include attributes.identityState.exact &#x3D; ACTIVE. The field keys must come from GET /public-identities/v2/visible-attributes and may use the prefix \&quot;attributes.\&quot; and/or the suffix \&quot;.exact\&quot;. See the request examples for the required exact payload structure.  Any authenticated user with the default scope can call this endpoint.
+     * @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.
+     */
+    searchPublicIdentitiesV2(requestParameters: SearchPublicIdentitiesV2RequestParams, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<Array<PublicIdentityV2>>;
+    searchPublicIdentitiesV2(requestParameters: SearchPublicIdentitiesV2RequestParams, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<Array<PublicIdentityV2>>>;
+    searchPublicIdentitiesV2(requestParameters: SearchPublicIdentitiesV2RequestParams, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<Array<PublicIdentityV2>>>;
     static ɵfac: i0.ɵɵFactoryDeclaration<PublicIdentitiesService, [null, { optional: true; }, { optional: true; }]>;
     static ɵprov: i0.ɵɵInjectableDeclaration<PublicIdentitiesService>;
 }
@@ -445,6 +832,30 @@ interface GetPublicIdentitiesV1429Response {
     message?: any | null;
 }
 
+/**
+ * Identity Security Cloud API - Public Identities
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * A set of COMPOSITE query entries combined with AND (matchAny false) or OR (matchAny true).
+ */
+interface PublicIdentitiesQuerySet {
+    /**
+     * When true, entries are OR\'d; when false, entries are AND\'d.
+     */
+    matchAny: boolean;
+    /**
+     * One or more TEXT or nested COMPOSITE entries.
+     */
+    entries: Array<PublicIdentitiesCompositeEntry>;
+}
+
 declare const BASE_PATH: InjectionToken<string>;
 declare const COLLECTION_FORMATS: {
     csv: string;
@@ -461,5 +872,5 @@ declare class ApiModule {
     static ɵinj: i0.ɵɵInjectorDeclaration<ApiModule>;
 }
 
-export { APIS, ApiModule, BASE_PATH, COLLECTION_FORMATS, Configuration, DtoType, LocaleOrigin, PublicIdentitiesService, PublicIdentityIdentityStateEnum };
-export type { ConfigurationParameters, DataFormat, DataType, ErrorMessageDto, ErrorResponseDto, GetPublicIdentitiesV1401Response, GetPublicIdentitiesV1429Response, GetPublicIdentitiesV1RequestParams, IdentityReference, Param, ParamLocation, ParamStyle, PublicIdentity, PublicIdentityAttributesInner, StandardDataFormat, StandardDataType, StandardParamStyle };
+export { APIS, ApiModule, BASE_PATH, COLLECTION_FORMATS, Configuration, DtoType, LocaleOrigin, PublicIdentitiesNestedCompositeEntryQueryTypeEnum, PublicIdentitiesSearchRequestIndicesEnum, PublicIdentitiesSearchRequestQueryTypeEnum, PublicIdentitiesService, PublicIdentitiesTextEntryQueryTypeEnum, PublicIdentityIdentityStateEnum, PublicIdentityV2IdentityStateEnum };
+export type { ConfigurationParameters, DataFormat, DataType, ErrorMessageDto, ErrorResponseDto, GetPublicIdentitiesV1401Response, GetPublicIdentitiesV1429Response, GetPublicIdentitiesV1RequestParams, GetPublicIdentitiesVisibleAttributesV2RequestParams, IdentityReference, Param, ParamLocation, ParamStyle, PublicIdentitiesCompositeEntry, PublicIdentitiesNestedCompositeEntry, PublicIdentitiesNestedQuerySet, PublicIdentitiesQuerySet, PublicIdentitiesSearchRequest, PublicIdentitiesSearchRequestQuerySet, PublicIdentitiesTextEntry, PublicIdentitiesTextQuery, PublicIdentitiesTextQueryTermsInner, PublicIdentity, PublicIdentityAttributeConfig, PublicIdentityAttributesInner, PublicIdentityV2, PublicIdentityV2Manager, PublicIdentityVisibleAttributes, SearchPublicIdentitiesV2RequestParams, StandardDataFormat, StandardDataType, StandardParamStyle };