nodes/generated

Interface MicrosoftEntraNodeParameters

Source
interface MicrosoftEntraNodeParameters {
    accountEnabled?: boolean;
    additionalFields?:
        | {
            description?: string;
            isAssignableToRole?: boolean;
            membershipRule?: string;
            membershipRuleProcessingState?: "On"
            | "Paused";
            preferredDataLocation?: string;
            uniqueName?: string;
            visibility?: "Private" | "Public";
        }
        | {
            aboutMe?: string;
            ageGroup?: "Adult"
            | "Minor"
            | "NotAdult";
            birthday?: string;
            businessPhones?: string;
            city?: string;
            companyName?: string;
            consentProvidedForMinor?:
                | "Denied"
                | "Granted"
                | "NotRequired";
            country?: string;
            department?: string;
            employeeHireDate?: string;
            employeeId?: string;
            employeeLeaveDateTime?: string;
            employeeOrgData?: {
                employeeOrgValues: {
                    costCenter?: string;
                    division?: string;
                };
            };
            employeeType?: string;
            forceChangePassword?: | "forceChangePasswordNextSignIn"
            | "forceChangePasswordNextSignInWithMfa";
            givenName?: string;
            interests?: string;
            jobTitle?: string;
            mail?: string;
            mobilePhone?: string;
            mySite?: string;
            officeLocation?: string;
            onPremisesImmutableId?: string;
            otherMails?: string;
            passwordPolicies?: (
                | "DisablePasswordExpiration"
                | "DisableStrongPassword"
            )[];
            pastProjects?: string;
            postalCode?: string;
            preferredLanguage?: string;
            responsibilities?: string;
            schools?: string;
            skills?: string;
            state?: string;
            streetAddress?: string;
            surname?: string;
            usageLocation?: string;
            userType?: "Guest"
            | "Member";
        };
    displayName?: string;
    fields?: unknown[];
    filter?: string;
    group?: { mode: "id"
    | "list"; value: string };
    groupType?: "" | "Unified";
    limit?: number;
    mailEnabled?: boolean;
    mailNickname?: string;
    membershipType?: "" | "DynamicMembership";
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "delete"
        | "addGroup"
        | "removeGroup";
    options?: { includeMembers?: boolean };
    output?: "simple" | "fields" | "raw";
    password?: string;
    resource?: "user" | "group";
    returnAll?: boolean;
    securityEnabled?: boolean;
    updateFields?:
        | {
            allowExternalSenders?: boolean;
            autoSubscribeNewMembers?: boolean;
            description?: string;
            displayName?: string;
            mailNickname?: string;
            membershipRule?: string;
            membershipRuleProcessingState?: "On"
            | "Paused";
            preferredDataLocation?: string;
            securityEnabled?: boolean;
            uniqueName?: string;
            visibility?: "Private" | "Public";
        }
        | {
            aboutMe?: string;
            accountEnabled?: boolean;
            ageGroup?: "Adult"
            | "Minor"
            | "NotAdult";
            birthday?: string;
            businessPhones?: string;
            city?: string;
            companyName?: string;
            consentProvidedForMinor?:
                | "Denied"
                | "Granted"
                | "NotRequired";
            country?: string;
            department?: string;
            displayName?: string;
            employeeHireDate?: string;
            employeeId?: string;
            employeeLeaveDateTime?: string;
            employeeOrgData?: {
                employeeOrgValues: {
                    costCenter?: string;
                    division?: string;
                };
            };
            employeeType?: string;
            forceChangePassword?: | "forceChangePasswordNextSignIn"
            | "forceChangePasswordNextSignInWithMfa";
            givenName?: string;
            interests?: string;
            jobTitle?: string;
            mail?: string;
            mailNickname?: string;
            mobilePhone?: string;
            mySite?: string;
            officeLocation?: string;
            onPremisesImmutableId?: string;
            otherMails?: string;
            password?: string;
            passwordPolicies?: (
                | "DisablePasswordExpiration"
                | "DisableStrongPassword"
            )[];
            pastProjects?: string;
            postalCode?: string;
            preferredLanguage?: string;
            responsibilities?: string;
            schools?: string;
            skills?: string;
            state?: string;
            streetAddress?: string;
            surname?: string;
            usageLocation?: string;
            userPrincipalName?: string;
            userType?: "Guest"
            | "Member";
        };
    user?: { mode: "id"
    | "list"; value: string };
    userPrincipalName?: string;
}

Properties§

Source§

readonly accountEnabled?: boolean

Whether the account is enabled Default: true

Source§

readonly additionalFields?:
    | {
        description?: string;
        isAssignableToRole?: boolean;
        membershipRule?: string;
        membershipRuleProcessingState?: "On"
        | "Paused";
        preferredDataLocation?: string;
        uniqueName?: string;
        visibility?: "Private" | "Public";
    }
    | {
        aboutMe?: string;
        ageGroup?: "Adult"
        | "Minor"
        | "NotAdult";
        birthday?: string;
        businessPhones?: string;
        city?: string;
        companyName?: string;
        consentProvidedForMinor?:
            | "Denied"
            | "Granted"
            | "NotRequired";
        country?: string;
        department?: string;
        employeeHireDate?: string;
        employeeId?: string;
        employeeLeaveDateTime?: string;
        employeeOrgData?: {
            employeeOrgValues: {
                costCenter?: string;
                division?: string;
            };
        };
        employeeType?: string;
        forceChangePassword?: | "forceChangePasswordNextSignIn"
        | "forceChangePasswordNextSignInWithMfa";
        givenName?: string;
        interests?: string;
        jobTitle?: string;
        mail?: string;
        mobilePhone?: string;
        mySite?: string;
        officeLocation?: string;
        onPremisesImmutableId?: string;
        otherMails?: string;
        passwordPolicies?: (
            | "DisablePasswordExpiration"
            | "DisableStrongPassword"
        )[];
        pastProjects?: string;
        postalCode?: string;
        preferredLanguage?: string;
        responsibilities?: string;
        schools?: string;
        skills?: string;
        state?: string;
        streetAddress?: string;
        surname?: string;
        usageLocation?: string;
        userType?: "Guest"
        | "Member";
    }

Default: {}

Source§

readonly displayName?: string

The name to display in the address book for the group

Source§

readonly fields?: unknown[]

The fields to add to the output Default: [] Type options: {"loadOptionsMethod":"getGroupProperties"}

Source§

readonly filter?: string

Query parameter to filter results by

Source§

readonly group?: { mode: "id" | "list"; value: string }

Default: {"mode":"list","value":""}

Source§

readonly groupType?: "" | "Unified"

Source§

readonly limit?: number

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

Source§

readonly mailEnabled?: boolean

Whether the group is mail-enabled

Source§

readonly mailNickname?: string

The mail alias for the group. Only enter the local-part without the domain.

Source§

readonly membershipType?: "" | "DynamicMembership"

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "addGroup"
    | "removeGroup"

Default: "getAll"

Source§

readonly options?: { includeMembers?: boolean }

Default: {}

Source§

readonly output?: "simple" | "fields" | "raw"

Default: "simple"

Source§

readonly password?: string

The password for the user Type options: {"password":true}

Source§

readonly resource?: "user" | "group"

Default: "user"

Source§

readonly returnAll?: boolean

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

Source§

readonly securityEnabled?: boolean

Whether the group is a security group Default: true

Source§

readonly updateFields?:
    | {
        allowExternalSenders?: boolean;
        autoSubscribeNewMembers?: boolean;
        description?: string;
        displayName?: string;
        mailNickname?: string;
        membershipRule?: string;
        membershipRuleProcessingState?: "On"
        | "Paused";
        preferredDataLocation?: string;
        securityEnabled?: boolean;
        uniqueName?: string;
        visibility?: "Private" | "Public";
    }
    | {
        aboutMe?: string;
        accountEnabled?: boolean;
        ageGroup?: "Adult"
        | "Minor"
        | "NotAdult";
        birthday?: string;
        businessPhones?: string;
        city?: string;
        companyName?: string;
        consentProvidedForMinor?:
            | "Denied"
            | "Granted"
            | "NotRequired";
        country?: string;
        department?: string;
        displayName?: string;
        employeeHireDate?: string;
        employeeId?: string;
        employeeLeaveDateTime?: string;
        employeeOrgData?: {
            employeeOrgValues: {
                costCenter?: string;
                division?: string;
            };
        };
        employeeType?: string;
        forceChangePassword?: | "forceChangePasswordNextSignIn"
        | "forceChangePasswordNextSignInWithMfa";
        givenName?: string;
        interests?: string;
        jobTitle?: string;
        mail?: string;
        mailNickname?: string;
        mobilePhone?: string;
        mySite?: string;
        officeLocation?: string;
        onPremisesImmutableId?: string;
        otherMails?: string;
        password?: string;
        passwordPolicies?: (
            | "DisablePasswordExpiration"
            | "DisableStrongPassword"
        )[];
        pastProjects?: string;
        postalCode?: string;
        preferredLanguage?: string;
        responsibilities?: string;
        schools?: string;
        skills?: string;
        state?: string;
        streetAddress?: string;
        surname?: string;
        usageLocation?: string;
        userPrincipalName?: string;
        userType?: "Guest"
        | "Member";
    }

Default: {}

Source§

readonly user?: { mode: "id" | "list"; value: string }

Default: {"mode":"list","value":""}

Source§

readonly userPrincipalName?: string

The user principal name (UPN)