Interface CreateImportUsersRequestContent

{
 *         users: fs.createReadStream("/path/to/your/file"),
 *         connection_id: "connection_id"
 *     }

interface CreateImportUsersRequestContent {
    users: FileLike;
    connection_id: string;
    upsert?: boolean;
    external_id?: string;
    send_completion_email?: boolean;
}

Properties

connection_id: string

connection_id of the connection to which users will be imported.

upsert?: boolean

Whether to update users if they already exist (true) or to ignore them (false).

external_id?: string

Customer-defined ID.

send_completion_email?: boolean

Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).