テストイベントを送信

POST https://{tenantDomain}/api/v2/event-streams/{id}/test

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.CreateEventStreamTestEventRequestContent{
        EventType: management.EventStreamTestEventTypeEnumUserCreated,
    }
    client.EventStreams.Test(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.eventStreams.test("id", {
        eventType: "user.created",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.eventStreams.test("id", {
        eventType: "user.created",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/event-streams/{id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {}
}'

import requests

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

payload = { "data": {} }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/event-streams/{id}/test",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/event-streams/{id}/test")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {}\n}"

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

202

{
  "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

ボディ

application/jsonapplication/x-www-form-urlencoded

Event Stream にテストイベントを送信するためのペイロード。

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

data · object

テストイベントの生のペイロード。

レスポンス

202

application/json

テストイベントが正常に送信されました。

特定のイベント配信試行に関するメタデータ

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