Frodo Library - v4.5.0
    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

    Methods

    createConfigEntity deleteConfigEntities deleteConfigEntitiesByType deleteConfigEntity exportConfigEntities exportConfigEntity importConfigEntities importSubConfigEntity readConfigEntities readConfigEntitiesByType readConfigEntity readConfigEntityStubs readConfigEntityTypes readManagedObjectTypes readSubConfigEntity removeSubConfigEntity updateConfigEntity

    Methods

    • 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, Cloud-only, relationship-property-specific alternative, 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, Cloud-only, relationship-property-specific alternative, 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.

    Settings

    Member Visibility

    On This Page

    Methods