Frodo Library - v5.0.0-47
    Preparing search index...

    Type Alias IdmConfig

    type IdmConfig = {
        createConfigEntity(
            entityId: string,
            entityData: IdObjectSkeletonInterface,
            wait?: boolean,
        ): Promise<IdObjectSkeletonInterface>;
        deleteConfigEntities(
            resultCallback?: ResultCallback<IdObjectSkeletonInterface>,
        ): Promise<IdObjectSkeletonInterface[]>;
        deleteConfigEntitiesByType(
            type: string,
            resultCallback?: ResultCallback<IdObjectSkeletonInterface>,
        ): Promise<IdObjectSkeletonInterface[]>;
        deleteConfigEntity(entityId: string): Promise<IdObjectSkeletonInterface>;
        exportConfigEntities(
            options?: ConfigEntityExportOptions,
            resultCallback?: ResultCallback<IdObjectSkeletonInterface>,
        ): Promise<ConfigEntityExportInterface>;
        exportConfigEntity(entityId: string): Promise<ConfigEntityExportInterface>;
        importConfigEntities(
            importData: ConfigEntityExportInterface,
            entityId?: string,
            options?: ConfigEntityImportOptions,
            resultCallback?: ResultCallback<IdObjectSkeletonInterface>,
        ): Promise<IdObjectSkeletonInterface[]>;
        importSubConfigEntity(
            entityId: string,
            updatedSubConfigEntity: IdObjectSkeletonInterface,
            options?: ConfigEntityImportOptions,
        ): Promise<IdObjectSkeletonInterface[]>;
        readConfigEntities(): Promise<IdObjectSkeletonInterface[]>;
        readConfigEntitiesByType(
            type: string,
            includeDefault?: boolean,
        ): Promise<IdObjectSkeletonInterface[]>;
        readConfigEntity(entityId: string): Promise<IdObjectSkeletonInterface>;
        readConfigEntityStubs(): Promise<IdmConfigStub[]>;
        readConfigEntityTypes(): Promise<string[]>;
        readManagedObjectTypes(): Promise<string[]>;
        readSubConfigEntity(
            entityId: string,
            name: string,
        ): Promise<NoIdObjectSkeletonInterface>;
        removeSubConfigEntity(
            entityId: string,
            name: string,
            options?: ConfigEntityImportOptions,
        ): Promise<IdObjectSkeletonInterface[]>;
        updateConfigEntity(
            entityId: string,
            entityData: IdObjectSkeletonInterface,
            wait?: boolean,
        ): Promise<IdObjectSkeletonInterface>;
    }
    Index
    • Import idm config entities. Every entity is tried: an entity that cannot be imported does not stop the others.

      Parameters

      • importData: ConfigEntityExportInterface

        idm config entity import data.

      • OptionalentityId: string

        Optional entity id that, when provided, will only import the entity of that id from the importData

      • Optionaloptions: ConfigEntityImportOptions

        import options

      • OptionalresultCallback: ResultCallback<IdObjectSkeletonInterface>

        Optional callback to process individual results. When given, the outcome of every entity is passed to it as it happens (a failed entity as an error that names it, with the cause nested) and a failed entity does not throw: the entities that could be imported are returned. Without it, the failures are collected and thrown as one error after every entity was tried. An entity that is protected in PingOne Advanced Identity Cloud (the tenant answers 403) is skipped: it is neither a result nor a failure, and the debug output names it.

      Returns Promise<IdObjectSkeletonInterface[]>

      a promise resolving to an array of the imported config entity objects

      If one or more entities cannot be imported and there is no result callback. The error carries one nested error per failed entity.

    • Import a idm sub config entity.

      Parameters

      Returns Promise<IdObjectSkeletonInterface[]>

      a promise resolving to an array of config entity objects

      For entityId: 'managed', this read-modify-writes the whole managed-object type definition (schema included), for any deployment type — including adding, changing, or removing individual custom property/relationship definitions (edit .schema.properties on the object you pass in). ManagedObjectSchemaOps.ts's updateManagedObjectSchemaProperty / removeManagedObjectSchemaProperty are a narrower, relationship-property-specific alternative (available wherever IDM runs -- Cloud and ForgeOps, not classic), not a general replacement.

    • Read all config entities of a type

      Parameters

      • type: string

        config entity type

      • OptionalincludeDefault: boolean

        Include default email templates if true, false to exclude them. Default: false

      Returns Promise<IdObjectSkeletonInterface[]>

      promise resolving to an array of config entities of a type

    • Read available config entity types

      Returns Promise<string[]>

      promise resolving to an array of config entity types

    • Read configured managed-object type names.

      Returns Promise<string[]>

    • Read a idm sub config entity.

      Parameters

      • entityId: string

        entity id for the parent config entity of the sub config entity that is being read

      • name: string

        name of the sub config entity that is being read

      Returns Promise<NoIdObjectSkeletonInterface>

      a promise resolving to a sub config entity object

      For entityId: 'managed', this reads the whole managed-object type definition (schema included), for any deployment type. This is the general-purpose per-property read path too — read the whole type and look up the property you need. ManagedObjectSchemaOps.ts's readManagedObjectSchemaProperty is a narrower, relationship-property- specific alternative (available wherever IDM runs -- Cloud and ForgeOps, not classic), not a general replacement.

    • Remove a idm sub config entity.

      Parameters

      • entityId: string

        entity id for parent config entity of the sub config that is being removed

      • name: string

        name of the sub config entity that is being removed

      • Optionaloptions: ConfigEntityImportOptions

        import options

      Returns Promise<IdObjectSkeletonInterface[]>

      a promise resolving to an array of config entity objects

      For entityId: 'managed', this removes a whole managed-object type definition (schema included), for any deployment type. To remove a single property within a type instead, use readSubConfigEntity / importSubConfigEntity to read-modify-write that type's .schema.properties.