Create import users job

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.

POST https://{tenantDomain}/api/v2/jobs/users-imports

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Jobs;
using System.IO;
using System.Text;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementClient(
            token: "<token>"
        );

        await client.Jobs.UsersImports.CreateAsync(
            new CreateImportUsersRequestContent {
                Users = new FileParameter(){
                    Stream = new MemoryStream(Encoding.UTF8.GetBytes("[bytes]"))
                },
                ConnectionId = "connection_id"
            }
        );
    }

}

package example

import (
    context "context"
    strings "strings"

    client "github.com/auth0/go-auth0/management/management/client"
    jobs "github.com/auth0/go-auth0/management/management/jobs"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &jobs.CreateImportUsersRequestContent{
        Users: strings.NewReader(
            "",
        ),
        ConnectionId: "connection_id",
    }
    client.Jobs.UsersImports.Create(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.core.FileStream;
import com.auth0.client.mgmt.resources.jobs.usersimports.requests.CreateImportUsersRequestContent;
import java.io.ByteArrayInputStream;
import java.nio.charset.StandardCharsets;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .token("<token>")
            .build();

        client.jobs().usersImports().create(
            new FileStream(new ByteArrayInputStream("[bytes]".getBytes(StandardCharsets.UTF_8))),
            CreateImportUsersRequestContent
                .builder()
                .connectionId("connection_id")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\Jobs\UsersImports\Requests\CreateImportUsersRequestContent;
use Auth0\SDK\API\Management\Utils\File;

$client = new Management(
    token: '<token>',
);
$client->jobs->usersImports->create(
    new CreateImportUsersRequestContent([
        'users' => File::createFromString("[bytes]", "[bytes]"),
        'connectionId' => 'connection_id',
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    token="<token>",
)

client.jobs.users_imports.create(
    users="[bytes]",
    connection_id="connection_id",
)

require "auth0"

client = Auth0::Management.new(token: "<token>")

client.jobs.users_imports.create

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.jobs.usersImports.create({
        connectionId: "connection_id",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.jobs.usersImports.create({
        connectionId: "connection_id",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/jobs/users-imports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'users=<string>' \
  --form connection_id=con_0000000000000001 \
  --form upsert=false \
  --form 'external_id=<string>' \
  --form send_completion_email=true

202

{
  "status": "pending",
  "type": "users_import",
  "created_at": "<string>",
  "id": "job_0000000000000001",
  "connection_id": "con_0000000000000001",
  "external_id": "<string>"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data

users · string · required

connection_id · string · default: con_0000000000000001 · required

connection_id of the connection to which users will be imported.

Pattern: ^con_[A-Za-z0-9]{16}$

upsert · boolean · default: false

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

external_id · string

Customer-defined ID.

send_completion_email · boolean · default: true

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

Response

202

application/json

Job successfully created.

status · string · default: pending · required

Status of this job.

type · string · default: users_import · required

Type of job this is.

created_at · string · required

When this job was created.

id · string · default: job_0000000000000001 · required

ID of this job.

connection_id · string · default: con_0000000000000001 · required

connection_id of the connection to which users will be imported.

Pattern: ^con_[A-Za-z0-9]{16}$

external_id · string

Customer-defined ID.