nodes/generated

Interface OktaNodeParameters

Source


interface OktaNodeParameters {
    activate?: boolean;
    email?: string;
    firstName?: string;
    getCreateFields?: {
        city?: string;
        costCenter?: string;
        countryCode?: string;
        department?: string;
        displayName?: string;
        division?: string;
        employeeNumber?: string;
        honorificPrefix?: string;
        honorificSuffix?: string;
        locale?: string;
        manager?: string;
        managerId?: string;
        middleName?: string;
        mobilePhone?: string;
        nickName?: string;
        organization?: string;
        password?: string;
        postalAddress?: string;
        preferredLanguage?: string;
        primaryPhone?: string;
        profileUrl?: string;
        recoveryQuestionAnswer?: string;
        recoveryQuestionQuestion?: string;
        secondEmail?: string;
        state?: string;
        streetAddress?: string;
        timezone?: string;
        title?: string;
        userType?: string;
        zipCode?: string;
    };
    getUpdateFields?: {
        city?: string;
        costCenter?: string;
        countryCode?: string;
        department?: string;
        displayName?: string;
        division?: string;
        email?: string;
        employeeNumber?: string;
        firstName?: string;
        honorificPrefix?: string;
        honorificSuffix?: string;
        lastName?: string;
        locale?: string;
        login?: string;
        manager?: string;
        managerId?: string;
        middleName?: string;
        mobilePhone?: string;
        nickName?: string;
        organization?: string;
        password?: string;
        postalAddress?: string;
        preferredLanguage?: string;
        primaryPhone?: string;
        profileUrl?: string;
        recoveryQuestionAnswer?: string;
        recoveryQuestionQuestion?: string;
        secondEmail?: string;
        state?: string;
        streetAddress?: string;
        timezone?: string;
        title?: string;
        userType?: string;
        zipCode?: string;
    };
    lastName?: string;
    limit?: number;
    login?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete";
    resource?: "user";
    returnAll?: boolean;
    searchQuery?: string;
    sendEmail?: boolean;
    simplify?: boolean;
    userId?: {
        mode: "id"
        | "list"
        | "login";
        value: string;
    };
}

Properties§

§readonly activate?: boolean

Whether to activate the user and allow access to all assigned applications Default: true

§readonly email?: string
§readonly firstName?: string
§readonly getCreateFields?: { ... }

Default: {}

§readonly getUpdateFields?: { ... }

Default: {}

§readonly lastName?: string
§readonly limit?: number

Max number of results to return Default: 20 Type options: {"minValue":1,"maxValue":200}

§readonly login?: string
§readonly operation?: "create" | "get" | "getAll" | "update" | "delete"

Default: "getAll"

§readonly resource?: "user"

Default: "user"

§readonly returnAll?: boolean

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

§readonly searchQuery?: string
§readonly sendEmail?: boolean

Whether to send a deactivation email to the administrator

§readonly simplify?: boolean

Whether to return a simplified version of the response instead of the raw data Default: true

§readonly userId?: { ... }

The user you want to operate on. Choose from the list, or specify an ID. Default: {"mode":"list","value":""}