Create export users job

Export all users to a file via a long-running job.

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

C#

C#

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

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.UsersExports.CreateAsync(
            new CreateExportUsersRequestContent()
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &jobs.CreateExportUsersRequestContent{}
    mgmt.Jobs.UsersExports.Create(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.jobs.types.CreateExportUsersRequestContent;

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

        client.jobs().usersExports().create(
            CreateExportUsersRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Jobs\UsersExports\Requests\CreateExportUsersRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->jobs->usersExports->create(
    new CreateExportUsersRequestContent([]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.jobs.users_exports.create()

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.jobs.users_exports.create

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.jobs.usersExports.create({});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.jobs.usersExports.create({});
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/jobs/users-exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection_id": "con_0000000000000001",
  "limit": 5,
  "fields": [
    {
      "name": "<string>",
      "export_as": "<string>"
    }
  ]
}
'

200

{
  "status": "pending",
  "type": "users_export",
  "id": "job_0000000000000001",
  "created_at": "<string>",
  "connection_id": "con_0000000000000001",
  "limit": 5,
  "fields": [
    {
      "name": "<string>",
      "export_as": "<string>"
    }
  ]
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Body

application/jsonapplication/x-www-form-urlencoded

connection_id · string · default: con_0000000000000001

connection_id of the connection from which users will be exported.

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

format · enum<string>

Format of the file. Must be json or csv.

Available options: json, csv

limit · integer · default: 5

Limit the number of records.

Required range: x >= 1

fields · object[]

List of fields to be included in the CSV. Defaults to a predefined set of fields.

Show child attributes

Response

200

application/json

Job created successfully.

status · string · default: pending · required

Status of this job.

type · string · default: users_export · required

Type of job this is.

id · string · default: job_0000000000000001 · required

ID of this job.

created_at · string

When this job was created.

connection_id · string · default: con_0000000000000001

connection_id of the connection from which users will be exported.

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

format · enum<string>

Format of the file. Must be json or csv.

Available options: json, csv

limit · integer · default: 5

Limit the number of records.

Required range: x >= 1

fields · object[]

List of fields to be included in the CSV. Defaults to a predefined set of fields.

Show child attributes