Create a log stream

Create a log stream.

Log Stream Types

The type of log stream being created determines the properties required in the sink payload.

HTTP Stream

For an http Stream, the sink properties are listed in the payload below.

Request:

{
  "name": "string",
  "type": "http",
  "sink": {
    "httpEndpoint": "string",
    "httpContentType": "string",
    "httpContentFormat": "JSONLINES|JSONARRAY",
    "httpAuthorization": "string"
  }
}

Response:

{
  "id": "string",
  "name": "string",
  "type": "http",
  "status": "active",
  "sink": {
    "httpEndpoint": "string",
    "httpContentType": "string",
    "httpContentFormat": "JSONLINES|JSONARRAY",
    "httpAuthorization": "string"
  }
}

Amazon EventBridge Stream

For an eventbridge Stream, the sink properties are listed in the payload below.

Request:

{
  "name": "string",
  "type": "eventbridge",
  "sink": {
    "awsRegion": "string",
    "awsAccountId": "string"
  }
}

The response will include an additional field awsPartnerEventSource in the sink:

Response:

{
  "id": "string",
  "name": "string",
  "type": "eventbridge",
  "status": "active",
  "sink": {
    "awsAccountId": "string",
    "awsRegion": "string",
    "awsPartnerEventSource": "string"
  }
}

Azure Event Grid Stream

For an Azure Event Grid Stream, the sink properties are listed in the payload below.

Request:

{
  "name": "string",
  "type": "eventgrid",
  "sink": {
    "azureSubscriptionId": "string",
    "azureResourceGroup": "string",
    "azureRegion": "string"
  }
}

Response:

{
  "id": "string",
  "name": "string",
  "type": "http",
  "status": "active",
  "sink": {
    "azureSubscriptionId": "string",
    "azureResourceGroup": "string",
    "azureRegion": "string",
    "azurePartnerTopic": "string"
  }
}

Datadog Stream

For a Datadog Stream, the sink properties are listed in the payload below.

Request:

{
  "name": "string",
  "type": "datadog",
  "sink": {
    "datadogRegion": "string",
    "datadogApiKey": "string"
  }
}

Response:

{
  "id": "string",
  "name": "string",
  "type": "datadog",
  "status": "active",
  "sink": {
    "datadogRegion": "string",
    "datadogApiKey": "string"
  }
}

Splunk Stream

For a Splunk Stream, the sink properties are listed in the payload below.

Request:

{
  "name": "string",
  "type": "splunk",
  "sink": {
    "splunkDomain": "string",
    "splunkToken": "string",
    "splunkPort": "string",
    "splunkSecure": "boolean"
  }
}

Response:

{
  "id": "string",
  "name": "string",
  "type": "splunk",
  "status": "active",
  "sink": {
    "splunkDomain": "string",
    "splunkToken": "string",
    "splunkPort": "string",
    "splunkSecure": "boolean"
  }
}

Sumo Logic Stream

For a Sumo Logic Stream, the sink properties are listed in the payload below.

Request:

{
  "name": "string",
  "type": "sumo",
  "sink": {
    "sumoSourceAddress": "string"
  }
}

Response:

{
  "id": "string",
  "name": "string",
  "type": "sumo",
  "status": "active",
  "sink": {
    "sumoSourceAddress": "string"
  }
}

POST https://{tenantDomain}/api/v2/log-streams

C#

C#

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

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.LogStreams.CreateAsync(
            new CreateLogStreamHttpRequestBody {
                Type = "http",
                Sink = new LogStreamHttpSink {
                    HttpEndpoint = "httpEndpoint"
                }
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v2/management"
    client "github.com/auth0/go-auth0/v2/management/client"
    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 := &management.CreateLogStreamRequestContent{
        CreateLogStreamHttpRequestBody: &management.CreateLogStreamHttpRequestBody{
            Type: management.LogStreamHttpEnum(
                "http",
            ),
            Sink: &management.LogStreamHttpSink{
                HttpEndpoint: "httpEndpoint",
            },
        },
    }
    mgmt.LogStreams.Create(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.CreateLogStreamHttpRequestBody;
import com.auth0.client.mgmt.types.CreateLogStreamRequestContent;
import com.auth0.client.mgmt.types.LogStreamHttpSink;

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

        client.logStreams().create(
            CreateLogStreamRequestContent.of(
                CreateLogStreamHttpRequestBody
                    .builder()
                    .type("http")
                    .sink(
                        LogStreamHttpSink
                            .builder()
                            .httpEndpoint("httpEndpoint")
                            .build()
                    )
                    .build()
            )
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Types\CreateLogStreamHttpRequestBody;
use Auth0\SDK\API\Management\Types\LogStreamHttpSink;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->logStreams->create(
    new CreateLogStreamHttpRequestBody([
        'type' => 'http',
        'sink' => new LogStreamHttpSink([
            'httpEndpoint' => 'httpEndpoint',
        ]),
    ]),
);

from auth0.management import ManagementClient, CreateLogStreamHttpRequestBody, LogStreamHttpSink

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

client.log_streams.create(
    request=CreateLogStreamHttpRequestBody(
        type="http",
        sink=LogStreamHttpSink(
            http_endpoint="httpEndpoint",
        ),
    ),
)

require "auth0"

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

client.log_streams.create(
  type: "http",
  sink: {
    http_endpoint: "httpEndpoint"
  }
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.logStreams.create({
        type: "http",
        sink: {
            httpEndpoint: "httpEndpoint",
        },
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.logStreams.create({
        type: "http",
        sink: {
            httpEndpoint: "httpEndpoint",
        },
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/log-streams \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "http",
  "sink": {
    "httpEndpoint": "<string>",
    "httpAuthorization": "<string>",
    "httpContentType": "<string>",
    "httpCustomHeaders": [
      {
        "header": "<string>",
        "value": "<string>"
      }
    ]
  },
  "name": "<string>",
  "isPriority": true,
  "filters": [
    {
      "type": "category"
    }
  ],
  "startFrom": "2021-03-01T19:57:29.532Z"
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "type": "http",
  "isPriority": true,
  "filters": [
    {
      "type": "category"
    }
  ],
  "pii_config": {
    "log_fields": [],
    "algorithm": "xxhash"
  },
  "sink": {
    "httpEndpoint": "<string>",
    "httpAuthorization": "<string>",
    "httpContentType": "<string>",
    "httpCustomHeaders": [
      {
        "header": "<string>",
        "value": "<string>"
      }
    ]
  }
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

type · enum<string> · 必須

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

sink · object · 必須

Show child attributes

name · string

log stream name

isPriority · boolean

True for priority log streams, false for non-priority

filters · object[]

Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered.

Show child attributes

pii_config · object

Show child attributes

startFrom · string · デフォルト: 2021-03-01T19:57:29.532Z

The optional datetime (ISO 8601) to start streaming logs from

レスポンス

200

application/json

Log stream created

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

id · string<log-stream-id>

The id of the log stream

name · string

log stream name

status · enum<string>

The status of the log stream. Possible values: active, paused, suspended

利用可能なオプション: active, paused, suspended

type · enum<string>

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

isPriority · boolean

True for priority log streams, false for non-priority

filters · object[]

Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered.

Show child attributes

pii_config · object

Show child attributes

sink · object

Show child attributes