Frodo Library - v4.7.0
    Preparing search index...

    Type Alias IdmFeature

    IDM tenant-configuration feature management (GET/POST /openidm/feature).

    This is a distinct resource from cloud.feature (FeatureOps.ts), despite the overlapping "feature" terminology and shared installedVersion field name -- confirmed live against a real tenant that they return entirely different, unrelated lists. cloud.feature.readFeatures/hasFeature read environment-level entitlement/licensing flags (e.g. identity-cloud, workforce, service-accounts) via a bare {host}/feature path already used internally by ServiceAccountOps.ts -- left untouched here. This module is for IDM's own tenant-configuration features (groups, aiagent, am/2fa/profiles, indexed/strings/6thru20, password/timestamps, etc.) that install new managed-object types/properties or repository indexes into the tenant, documented at https://docs.pingidentity.com/pingoneaic/idm-rest-api/endpoints/rest-feature.md.

    Installing a feature is irreversible: per that same documentation, uninstalling or disabling a feature once installed requires contacting Ping support and rolling back the tenant. There is no self-service undo.

    type IdmFeature = {
        hasIdmFeature(featureId: string): Promise<boolean>;
        installIdmFeature(featureId: string): Promise<IdmFeatureActionResult>;
        readIdmFeature(featureId: string): Promise<IdmFeatureInterface>;
        readIdmFeatures(): Promise<IdmFeatureInterface[]>;
        validateIdmFeature(featureId: string): Promise<IdmFeatureActionResult>;
    }
    Index

    Methods

    hasIdmFeature installIdmFeature readIdmFeature readIdmFeatures validateIdmFeature

    Methods

    • Check if an IDM tenant-configuration feature is installed.

      Parameters

      • featureId: string

        feature id, e.g. 'aiagent'

      Returns Promise<boolean>

      a promise that resolves to true if the feature is installed

    Settings

    Member Visibility

    On This Page

    Methods