ユーザーエクスポートを作成

長時間実行されるジョブを使用して、すべてのユーザーをファイルにエクスポートします。

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
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

connection_id · string · デフォルト: con_0000000000000001

ユーザーのエクスポート元となる接続の connection_id。

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

fields · object[]

CSV に含めるフィールドの一覧。既定では、定義済みのフィールドセットが使用されます。

Show child attributes

format · enum<string>

ファイルの形式。json または csv である必要があります。

利用可能なオプション: json, csv

limit · integer · デフォルト: 5

レコード数を制限します。

必須範囲: x >= 1

レスポンス

200

application/json

ジョブが正常に作成されました。

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

このジョブの ID。

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

このジョブのステータス。

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

このジョブの種類。

connection_id · string · デフォルト: con_0000000000000001

ユーザーのエクスポート元となる接続の connection_id。

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

created_at · string

このジョブの作成日時。

fields · object[]

CSV に含めるフィールドの一覧。既定では、定義済みのフィールドセットが使用されます。

Show child attributes

format · enum<string>

ファイルの形式。json または csv である必要があります。

利用可能なオプション: json, csv

limit · integer · デフォルト: 5

レコード数を制限します。

必須範囲: x >= 1