Back to Node Auth0

Class UsersImportsClient

docs/classes/management.SDK.UsersImportsClient.html

5.9.13.1 KB
Original Source

Class UsersImportsClient

Index

Constructors

constructor

Methods

create

Properties

_options

Constructors

constructor

new UsersImportsClient(options: BaseClientOptions): UsersImportsClient

Parameters

Returns UsersImportsClient

Methods

create

create(
request: CreateImportUsersRequestContent,
requestOptions?: UsersImportsClient.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-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" })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods create Properties _options