Crear exportaciones de usuarios

Exporte todos los usuarios a un archivo mediante un trabajo de larga duración.

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
}

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Cuerpo

application/jsonapplication/x-www-form-urlencoded

connection_id · string · predeterminado: con_0000000000000001

connection_id de la conexión desde la que se exportarán los usuarios.

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

fields · object[]

Lista de campos que se incluirán en el CSV. De forma predeterminada, se usa un conjunto predefinido de campos.

Show child attributes

format · enum<string>

Formato del archivo. Debe ser json o csv.

Opciones disponibles: json, csv

limit · integer · predeterminado: 5

Limita el número de registros.

Rango requerido: x >= 1

Respuesta

200

application/json

Trabajo creado correctamente.

id · string · predeterminado: job_0000000000000001 · requerido

ID de este trabajo.

status · string · predeterminado: pending · requerido

Estado de este trabajo.

type · string · predeterminado: users_export · requerido

Tipo de este trabajo.

connection_id · string · predeterminado: con_0000000000000001

connection_id de la conexión desde la que se exportarán los usuarios.

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

created_at · string

Fecha de creación de este trabajo.

fields · object[]

Lista de campos que se incluirán en el CSV. De forma predeterminada, se usa un conjunto predefinido de campos.

Show child attributes

format · enum<string>

Formato del archivo. Debe ser json o csv.

Opciones disponibles: json, csv

limit · integer · predeterminado: 5

Limita el número de registros.

Rango requerido: x >= 1