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

    Type Alias ManagedSystemObject

    type ManagedSystemObject = {
        addRelationship(
            type: string,
            id: string,
            field: string,
            target: RelationshipTarget,
            rev?: string,
        ): Promise<IdObjectSkeletonInterface>;
        countManagedSystemObjects(type: string, filter?: string): Promise<number>;
        createManagedSystemObject(
            type: string,
            moData: IdObjectSkeletonInterface,
            id?: string,
        ): Promise<IdObjectSkeletonInterface>;
        deleteManagedSystemObject(
            type: string,
            id: string,
        ): Promise<IdObjectSkeletonInterface>;
        deleteManagedSystemObjects(type: string, filter: string): Promise<number>;
        queryManagedSystemObjects(
            type: string,
            filter?: string,
            fields?: string[],
            pageSize?: number,
        ): Promise<IdObjectSkeletonInterface[]>;
        queryRelatedManagedSystemObjects(
            type: string,
            id: string,
            relationship: string,
            fields?: string[],
            pageSize?: number,
        ): Promise<IdObjectSkeletonInterface[]>;
        readManagedSystemObject(
            type: string,
            id: string,
            fields: string[],
        ): Promise<IdObjectSkeletonInterface>;
        readManagedSystemObjects(
            type: string,
            fields: string[],
        ): Promise<IdObjectSkeletonInterface[]>;
        readRelationship(type: string, id: string, field: string): Promise<unknown>;
        removeRelationship(
            type: string,
            id: string,
            field: string,
            target: RelationshipTarget,
            rev?: string,
        ): Promise<IdObjectSkeletonInterface>;
        replaceRelationship(
            type: string,
            id: string,
            field: string,
            target: RelationshipTarget | RelationshipTarget[],
            rev?: string,
        ): Promise<IdObjectSkeletonInterface>;
        updateManagedSystemObject(
            type: string,
            id: string,
            moData: IdObjectSkeletonInterface,
        ): Promise<IdObjectSkeletonInterface>;
        updateManagedSystemObjectProperties(
            type: string,
            id: string,
            operations: PatchOperationInterface[],
            rev?: string,
        ): Promise<IdObjectSkeletonInterface>;
        updateManagedSystemObjectsProperties(
            type: string,
            filter: string,
            operations: PatchOperationInterface[],
            rev?: string,
            pageSize?: number,
        ): Promise<IdObjectSkeletonInterface[]>;
    }
    Index

    Methods

    addRelationship countManagedSystemObjects createManagedSystemObject deleteManagedSystemObject deleteManagedSystemObjects queryManagedSystemObjects queryRelatedManagedSystemObjects readManagedSystemObject readManagedSystemObjects readRelationship removeRelationship replaceRelationship updateManagedSystemObject updateManagedSystemObjectProperties updateManagedSystemObjectsProperties

    Methods

    • Add one target to a many-valued relationship field without disturbing any existing members.

      Parameters

      • type: string

        managed system object type, e.g. svcacct or teammember

      • id: string

        managed system object id

      • field: string

        relationship field name

      • target: RelationshipTarget

        the object to add, as plain { type, id }

      • Optionalrev: string

        optional optimistic concurrency revision token

      Returns Promise<IdObjectSkeletonInterface>

      the patched object

    • Count managed system objects of the specified type.

      Parameters

      • type: string

        managed system object type, e.g. teammember or svcacct

      • Optionalfilter: string

        CREST search filter

      Returns Promise<number>

      a promise that resolves to the object count

    • Delete managed system objects by filter

      Parameters

      • type: string

        managed system object type, e.g. alpha_user or user

      • filter: string

        filter

      Returns Promise<number>

      a promise that resolves the number of deleted objects

    • Query managed system objects

      Parameters

      • type: string

        managed system object type, e.g. alpha_user or user

      • Optionalfilter: string

        CREST search filter

      • Optionalfields: string[]

        array of fields to return

      • OptionalpageSize: number

      Returns Promise<IdObjectSkeletonInterface[]>

      a promise resolving to an array of managed system objects

    • Query related managed system objects

      Parameters

      • type: string

        managed system object type, e.g. svcacct or teammember

      • id: string

        managed system object id

      • relationship: string

        name of the relationship to query

      • Optionalfields: string[]

        array of fields to return

      • OptionalpageSize: number

        page size

      Returns Promise<IdObjectSkeletonInterface[]>

      a promise resolving to an array of managed system objects

    • Read managed system object

      Parameters

      • type: string

        managed system object type, e.g. alpha_user or user

      • id: string

        managed system object id

      • fields: string[]

        array of fields to include

      Returns Promise<IdObjectSkeletonInterface>

      a promise that resolves to an IdObjectSkeletonInterface

    • Read all managed system object of the specified type

      Parameters

      • type: string

        managed system object type, e.g. alpha_user or user

      • fields: string[]

        array of fields to return

      Returns Promise<IdObjectSkeletonInterface[]>

      a promise that resolves to an array of IdObjectSkeletonInterfaces

    • Read the current value of a relationship field directly off a managed system object (the forward direction). For the reverse direction use queryRelatedManagedSystemObjects.

      Parameters

      • type: string

        managed system object type, e.g. svcacct or teammember

      • id: string

        managed system object id

      • field: string

        relationship field name

      Returns Promise<unknown>

      the field's current value: a single ref object, an array of them, or null/undefined if unset

    • Remove one target from a many-valued relationship field without disturbing any other members.

      Parameters

      • type: string

        managed system object type, e.g. svcacct or teammember

      • id: string

        managed system object id

      • field: string

        relationship field name

      • target: RelationshipTarget

        the object to remove, as plain { type, id }

      • Optionalrev: string

        optional optimistic concurrency revision token

      Returns Promise<IdObjectSkeletonInterface>

      the patched object

    • Replace the entire value of a relationship field: a single target (or null to clear it) for a single-valued field, or an array of targets for a many-valued field. Replaces the whole field — use addRelationship/removeRelationship to change one member of a many-valued field without disturbing the rest.

      Parameters

      • type: string

        managed system object type, e.g. svcacct or teammember

      • id: string

        managed system object id

      • field: string

        relationship field name

      • target: RelationshipTarget | RelationshipTarget[]

        the new value

      • Optionalrev: string

        optional optimistic concurrency revision token

      Returns Promise<IdObjectSkeletonInterface>

      the patched object

    • Partially update managed system object through a collection of patch operations.

      Parameters

      • type: string

        managed system object type, e.g. alpha_user or user

      • id: string

        managed system object id

      • operations: PatchOperationInterface[]

        collection of patch operations to perform on the object

      • Optionalrev: string

        managed system object revision

      Returns Promise<IdObjectSkeletonInterface>

      a promise that resolves to an IdObjectSkeletonInterface

    • Partially update multiple managed system object through a collection of patch operations.

      Parameters

      • type: string

        managed system object type, e.g. alpha_user or user

      • filter: string

        CREST search filter

      • operations: PatchOperationInterface[]

        collection of patch operations to perform on the object

      • Optionalrev: string

        managed system object revision

      • OptionalpageSize: number

        page size

      Returns Promise<IdObjectSkeletonInterface[]>

      a promise that resolves to an IdObjectSkeletonInterface

    Settings

    Member Visibility

    On This Page

    Methods