Class UsersImports

Index

Constructors

Methods

create _getAuthorizationHeader

Properties

Constructors

constructor

new UsersImports(_options: UsersImports.Options): UsersImports
Parameters
- _options: UsersImports.Options
Returns UsersImports

Methods

create

create(
request: Management.CreateImportUsersRequestContent,
requestOptions?: UsersImports.RequestOptions,
): HttpResponsePromise<CreateImportUsersResponseContent>
Import users from a formatted file into a connection via a long-running job. When importing users, with or without upsert, the email_verified is set to false when the email address is added or updated. Users must verify their email address. To avoid this behavior, set email_verified to true in the imported data.
Parameters
- request: Management.CreateImportUsersRequestContent
- OptionalrequestOptions: UsersImports.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateImportUsersResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ContentTooLargeError

Throws
Management.TooManyRequestsError

Throws
Management.InternalServerError
Example
```
import { createReadStream } from "fs";
    await client.jobs.usersImports.create({
        users: fs.createReadStream("/path/to/your/file"),
        connection_id: "connection_id"
    })
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: UsersImports.Options