イベント配信を取得

GET https://{tenantDomain}/api/v2/event-streams/{id}/deliveries

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &eventstreams.ListEventStreamDeliveriesRequestParameters{
        Statuses: management.String(
            "statuses",
        ),
        EventTypes: management.String(
            "event_types",
        ),
        DateFrom: management.String(
            "date_from",
        ),
        DateTo: management.String(
            "date_to",
        ),
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
    }
    client.EventStreams.Deliveries.List(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.eventStreams.deliveries.list("id", {
        statuses: "statuses",
        eventTypes: "event_types",
        dateFrom: "date_from",
        dateTo: "date_to",
        from: "from",
        take: 1,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.eventStreams.deliveries.list("id", {
        statuses: "statuses",
        eventTypes: "event_types",
        dateFrom: "date_from",
        dateTo: "date_to",
        from: "from",
        take: 1,
    });
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/event-streams/{id}/deliveries \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/event-streams/{id}/deliveries"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/event-streams/{id}/deliveries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/event-streams/{id}/deliveries")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/event-streams/{id}/deliveries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

[
  {
    "attempts": [
      {
        "status": "failed",
        "timestamp": "2023-11-07T05:31:56Z",
        "error_message": "<string>"
      }
    ],
    "event_stream_id": "<string>",
    "id": "<string>",
    "status": "failed",
    "event": {
      "data": "<string>",
      "id": "<string>",
      "source": "<string>",
      "specversion": "<string>",
      "time": "2023-11-07T05:31:56Z",
      "type": "<string>"
    }
  }
]

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

Event Stream の一意の識別子。

Required string length: 26

クエリパラメータ

statuses · string

絞り込みに使用するステータスのカンマ区切りリスト

event_types · string

絞り込みに使用するイベントタイプのカンマ区切りリスト

date_from · string

再配信の開始時刻を表す RFC-3339 形式の日時です（この時刻を含む）。サブ秒精度は使用できません。

Maximum string length: 20

date_to · string

再配信の終了時刻を表す RFC-3339 形式の日時です（この時刻を含まない）。サブ秒精度は使用できません。

Maximum string length: 20

from · string

選択を開始する位置を示す省略可能な Id。

take · integer

1 ページあたりの結果数。既定値は 50 です。

必須範囲: 1 <= x <= 100

レスポンス

200

application/json

Event Stream の配信情報が正常に取得されました。

attempts · object[] · 必須

配信試行の結果

Show child attributes

event_stream_id · string<event-stream-id> · 必須

Event Stream の一意の識別子。

Required string length: 26

event_type · enum<string> · 必須

イベントタイプ

利用可能なオプション: group.created, group.deleted, group.member.added, group.member.deleted, group.role.assigned, group.role.deleted, group.updated, organization.connection.added, organization.connection.removed, organization.connection.updated, organization.created, organization.deleted, organization.group.role.assigned, organization.group.role.deleted, organization.member.added, organization.member.deleted, organization.member.role.assigned, organization.member.role.deleted, organization.updated, user.created, user.deleted, user.updated

Maximum string length: 33

id · string · 必須

配信の一意の識別子

status · enum<string> · 必須

配信ステータス

利用可能なオプション: failed

Maximum string length: 6

event · object

イベントの内容。配信に失敗した場合にのみ設定されます。

Show child attributes