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

Go

Go

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,
    )
}

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

import requests

url = "https://{tenantDomain}/api/v2/jobs/users-imports"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"users\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"connection_id\"\r\n\r\ncon_0000000000000001\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upsert\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_completion_email\"\r\n\r\ntrue\r\n-----011000010111000001101001--"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "multipart/form-data; boundary=---011000010111000001101001"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/jobs/users-imports",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"users\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"connection_id\"\r\n\r\ncon_0000000000000001\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upsert\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_completion_email\"\r\n\r\ntrue\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data; boundary=---011000010111000001101001"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/jobs/users-imports")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"users\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"connection_id\"\r\n\r\ncon_0000000000000001\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upsert\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_completion_email\"\r\n\r\ntrue\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/jobs/users-imports")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'multipart/form-data; boundary=---011000010111000001101001'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"users\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"connection_id\"\r\n\r\ncon_0000000000000001\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upsert\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_completion_email\"\r\n\r\ntrue\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

202

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

ボディ

multipart/form-data

users · string · 必須

connection_id · string · デフォルト: con_0000000000000001 · 必須

connection_id of the connection to which users will be imported.

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

upsert · boolean · デフォルト: 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 · デフォルト: true

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

レスポンス

202

application/json

Job successfully created.

status · string · デフォルト: pending · 必須

Status of this job.

type · string · デフォルト: users_import · 必須

Type of job this is.

created_at · string · 必須

When this job was created.

id · string · デフォルト: job_0000000000000001 · 必須

ID of this job.

connection_id · string · デフォルト: con_0000000000000001 · 必須

connection_id of the connection to which users will be imported.

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

external_id · string

Customer-defined ID.