Get this event stream's delivery history

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

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.EventStreams;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.EventStreams.Deliveries.ListAsync(
            id: "id",
            request: new ListEventStreamDeliveriesRequestParameters {
                Statuses = "statuses",
                EventTypes = "event_types",
                DateFrom = "date_from",
                DateTo = "date_to",
                From = "from",
                Take = 1
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    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,
        ),
    }
    mgmt.EventStreams.Deliveries.List(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.eventstreams.types.ListEventStreamDeliveriesRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.eventStreams().deliveries().list(
            "id",
            ListEventStreamDeliveriesRequestParameters
                .builder()
                .statuses("statuses")
                .eventTypes("event_types")
                .dateFrom("date_from")
                .dateTo("date_to")
                .from("from")
                .take(1)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\EventStreams\Deliveries\Requests\ListEventStreamDeliveriesRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->eventStreams->deliveries->list(
    'id',
    new ListEventStreamDeliveriesRequestParameters([
        'statuses' => 'statuses',
        'eventTypes' => 'event_types',
        'dateFrom' => 'date_from',
        'dateTo' => 'date_to',
        'from' => 'from',
        'take' => 1,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.event_streams.deliveries.list(
    id="id",
    statuses="statuses",
    event_types="event_types",
    date_from="date_from",
    date_to="date_to",
    from="from",
    take=1,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.event_streams.deliveries.list(
  id: "id",
  statuses: "statuses",
  event_types: "event_types",
  date_from: "date_from",
  date_to: "date_to",
  from: "from",
  take: 1
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        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({
        domain: "{YOUR_DOMAIN}",
        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>'

200

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

Unique identifier for the event stream.

Required string length: 26

クエリパラメータ

statuses · string

Comma-separated list of statuses by which to filter

event_types · string

Comma-separated list of event types by which to filter

date_from · string

An RFC-3339 date-time for redelivery start, inclusive. Does not allow sub-second precision.

Maximum string length: 20

date_to · string

An RFC-3339 date-time for redelivery end, exclusive. Does not allow sub-second precision.

Maximum string length: 20

from · string

Optional Id from which to start selection.

take · integer

Number of results per page. Defaults to 50.

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

レスポンス

200

application/json

Event stream deliveries successfully retrieved.

id · string · 必須

Unique identifier for the delivery

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

Unique identifier for the event stream.

Required string length: 26

status · enum<string> · 必須

Delivery status

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

Maximum string length: 6

event_type · enum<string> · 必須

Type of event

利用可能なオプション: connection.created, connection.deleted, connection.updated, 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

attempts · object[] · 必須

Results of delivery attempts

Show child attributes

event · object

Event content. This will only be set if delivery failed.

Show child attributes