TypeScript
import { ManagementClient } from "auth0";
import * as fs from "fs";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.jobs.usersImports.create({
users: fs.createReadStream("/path/to/your/file"),
connection_id: "connection_id",
});
}
main();
import { ManagementClient } from "auth0";
import * as fs from "fs";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.jobs.usersImports.create({
users: fs.createReadStream("/path/to/your/file"),
connection_id: "connection_id",
});
}
main();
package example
import (
context "context"
strings "strings"
management "github.com/auth0/go-auth0/v3/management"
client "github.com/auth0/go-auth0/v3/management/client"
option "github.com/auth0/go-auth0/v3/management/option"
)
func do() {
mgmt, err := client.New(
"{YOUR_DOMAIN}",
option.WithToken(
"<token>",
),
)
if err != nil {
return
}
request := &management.CreateImportUsersRequestContent{
Users: strings.NewReader(
"",
),
ConnectionID: "connection_id",
}
mgmt.Jobs.UsersImports.Create(
context.TODO(),
request,
)
}
# Ensure you're logged in: auth0 login
auth0 api post "jobs/users-imports" --data '{
"connection_id": "connection_id"
}'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 ManagementApiClient(
token: "<token>",
clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
);
await client.Jobs.UsersImports.CreateAsync(
new CreateImportUsersRequestContent {
Users = new FileParameter(){
Stream = new MemoryStream(Encoding.UTF8.GetBytes("[bytes]"))
},
ConnectionId = "connection_id"
}
);
}
}
package com.example.usage;
import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.jobs.types.CreateImportUsersRequestContent;
public class Example {
public static void main(String[] args) {
ManagementApi client = ManagementApi
.builder()
.domain("{YOUR_DOMAIN}")
.token("<token>")
.build();
client.jobs().usersImports().create(
null,
CreateImportUsersRequestContent
.builder()
.connectionId("connection_id")
.build()
);
}
}<?php
namespace Example;
use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Jobs\UsersImports\Requests\CreateImportUsersRequestContent;
use Auth0\SDK\API\Management\Utils\File;
$client = new ManagementClient(new ManagementClientOptions(
domain: '{YOUR_DOMAIN}',
token: '<token>',
));
$client->jobs->usersImports->create(
new CreateImportUsersRequestContent([
'users' => File::createFromString("example_users", "example_users"),
'connectionId' => 'connection_id',
]),
);
from auth0.management import ManagementClient
client = ManagementClient(
domain="{YOUR_DOMAIN}",
token="<token>",
)
client.jobs.users_imports.create(
users="example_users",
connection_id="connection_id",
)
require "auth0"
client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")
client.jobs.users_imports.create
curl --request POST \
--url https://{tenantDomain}/api/v2/jobs/users-imports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form users=@example-file \
--form connection_id=con_0000000000000001 \
--form upsert=false \
--form 'external_id=<string>' \
--form send_completion_email=true{
"status": "pending",
"type": "users_import",
"created_at": "<string>",
"id": "job_0000000000000001",
"connection_id": "con_0000000000000001",
"external_id": "<string>"
}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
TypeScript
import { ManagementClient } from "auth0";
import * as fs from "fs";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.jobs.usersImports.create({
users: fs.createReadStream("/path/to/your/file"),
connection_id: "connection_id",
});
}
main();
import { ManagementClient } from "auth0";
import * as fs from "fs";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.jobs.usersImports.create({
users: fs.createReadStream("/path/to/your/file"),
connection_id: "connection_id",
});
}
main();
package example
import (
context "context"
strings "strings"
management "github.com/auth0/go-auth0/v3/management"
client "github.com/auth0/go-auth0/v3/management/client"
option "github.com/auth0/go-auth0/v3/management/option"
)
func do() {
mgmt, err := client.New(
"{YOUR_DOMAIN}",
option.WithToken(
"<token>",
),
)
if err != nil {
return
}
request := &management.CreateImportUsersRequestContent{
Users: strings.NewReader(
"",
),
ConnectionID: "connection_id",
}
mgmt.Jobs.UsersImports.Create(
context.TODO(),
request,
)
}
# Ensure you're logged in: auth0 login
auth0 api post "jobs/users-imports" --data '{
"connection_id": "connection_id"
}'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 ManagementApiClient(
token: "<token>",
clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
);
await client.Jobs.UsersImports.CreateAsync(
new CreateImportUsersRequestContent {
Users = new FileParameter(){
Stream = new MemoryStream(Encoding.UTF8.GetBytes("[bytes]"))
},
ConnectionId = "connection_id"
}
);
}
}
package com.example.usage;
import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.jobs.types.CreateImportUsersRequestContent;
public class Example {
public static void main(String[] args) {
ManagementApi client = ManagementApi
.builder()
.domain("{YOUR_DOMAIN}")
.token("<token>")
.build();
client.jobs().usersImports().create(
null,
CreateImportUsersRequestContent
.builder()
.connectionId("connection_id")
.build()
);
}
}<?php
namespace Example;
use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Jobs\UsersImports\Requests\CreateImportUsersRequestContent;
use Auth0\SDK\API\Management\Utils\File;
$client = new ManagementClient(new ManagementClientOptions(
domain: '{YOUR_DOMAIN}',
token: '<token>',
));
$client->jobs->usersImports->create(
new CreateImportUsersRequestContent([
'users' => File::createFromString("example_users", "example_users"),
'connectionId' => 'connection_id',
]),
);
from auth0.management import ManagementClient
client = ManagementClient(
domain="{YOUR_DOMAIN}",
token="<token>",
)
client.jobs.users_imports.create(
users="example_users",
connection_id="connection_id",
)
require "auth0"
client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")
client.jobs.users_imports.create
curl --request POST \
--url https://{tenantDomain}/api/v2/jobs/users-imports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form users=@example-file \
--form connection_id=con_0000000000000001 \
--form upsert=false \
--form 'external_id=<string>' \
--form send_completion_email=true{
"status": "pending",
"type": "users_import",
"created_at": "<string>",
"id": "job_0000000000000001",
"connection_id": "con_0000000000000001",
"external_id": "<string>"
}Authorizations
bearerAuthoAuth2ClientCredentials
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
multipart/form-data
connection_id of the connection to which users will be imported.
Pattern:
^con_[A-Za-z0-9]{16}$Whether to update users if they already exist (true) or to ignore them (false).
Customer-defined ID.
Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
Response
Job successfully created.
Status of this job.
Type of job this is.
When this job was created.
ID of this job.
connection_id of the connection to which users will be imported.
Pattern:
^con_[A-Za-z0-9]{16}$Customer-defined ID.