• management
• Management
• CreateImportUsersRequestContent

Interface CreateImportUsersRequestContent

Example

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

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

Index

Properties

usersconnection_idupsert?external_id?send_completion_email?

Properties

users

users: Uploadable

connection_id

connection_id: string

connection_id of the connection to which users will be imported.

Optionalupsert

upsert?: boolean

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

Optionalexternal_id

external_id?: string

Customer-defined ID.

Optionalsend_completion_email

send_completion_email?: boolean

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

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties usersconnection_idupsertexternal_idsend_completion_email