Créer une exportation d’utilisateurs

Exporte tous les utilisateurs dans un fichier au moyen d’une tâche de longue durée.

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

Go

Go

package example

import (
    context "context"

    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.CreateExportUsersRequestContent{}
    client.Jobs.UsersExports.Create(
        context.TODO(),
        request,
    )
}

200

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

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Corps

application/jsonapplication/x-www-form-urlencoded

connection_id · string · défaut: con_0000000000000001

connection_id de la connexion à partir de laquelle les utilisateurs seront exportés.

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

fields · object[]

Liste des champs à inclure dans le CSV. Par défaut, un ensemble prédéfini de champs est utilisé.

Show child attributes

format · enum<string>

Format du fichier. Doit être json ou csv.

Options disponibles: json, csv

limit · integer · défaut: 5

Limiter le nombre d’enregistrements.

Plage requise: x >= 1

Réponse

200

application/json

Tâche créée avec succès.

id · string · défaut: job_0000000000000001 · requis

ID de cette tâche.

status · string · défaut: pending · requis

Statut de cette tâche.

type · string · défaut: users_export · requis

Type de cette tâche.

connection_id · string · défaut: con_0000000000000001

connection_id de la connexion à partir de laquelle les utilisateurs seront exportés.

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

created_at · string

Date de création de cette tâche.

fields · object[]

Liste des champs à inclure dans le CSV. Par défaut, un ensemble prédéfini de champs est utilisé.

Show child attributes

format · enum<string>

Format du fichier. Doit être json ou csv.

Options disponibles: json, csv

limit · integer · défaut: 5

Limiter le nombre d’enregistrements.

Plage requise: x >= 1