nodes/generated

Interface LdapNodeParameters

Source


interface LdapNodeParameters {
    attribute?: string;
    attributes?:
        | { attribute: { id: string; value?: string }[] }
        | {
            add: { id: string; value?: string }[];
            delete: { id: string; value?: string }[];
            replace: { id: string; value?: string }[];
        };
    baseDN?: string;
    customFilter?: string;
    dn?: string;
    id?: string;
    limit?: number;
    nodeDebug?: boolean;
    operation?: | "create"
    | "update"
    | "delete"
    | "search"
    | "rename"
    | "compare";
    options?: {
        attributes?: unknown[];
        pageSize?: number;
        scope?: "base"
        | "sub"
        | "one";
    };
    returnAll?: boolean;
    searchFor?: string;
    searchText?: string;
    targetDn?: string;
    value?: string;
}

Properties§

§readonly attribute?: string

Attribute to search for Default: [] Type options: {"loadOptionsMethod":"getAttributes"}

§readonly attributes?:
    | { attribute: { id: string; value?: string }[] }
    | {
        add: { id: string; value?: string }[];
        delete: { id: string; value?: string }[];
        replace: { id: string; value?: string }[];
    }

Attributes to add to the entry Default: {} Type options: {"multipleValues":true}

§readonly baseDN?: string

The distinguished name of the subtree to search in

§readonly customFilter?: string

Custom LDAP filter. Escape these chars * ( ) \ with a backslash "". Default: "(objectclass=*)"

§readonly dn?: string

The distinguished name of the entry to compare Type options: {"alwaysOpenEditWindow":false}

§readonly id?: string

The ID of the attribute to compare Default: [] Type options: {"loadOptionsMethod":"getAttributesForDn"}

§readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1}

§readonly nodeDebug?: boolean
§readonly operation?:
    | "create"
    | "update"
    | "delete"
    | "search"
    | "rename"
    | "compare"

Default: "search"

§readonly options?: { ... }

Default: {}

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly searchFor?: string

Directory object class to search for Default: [] Type options: {"loadOptionsMethod":"getObjectClasses"}

§readonly searchText?: string

Text to search for, Use * for a wildcard

§readonly targetDn?: string

The new distinguished name for the entry

§readonly value?: string

The value to compare