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.UpdateAsync(
            id: "id",
            request: new UpdateLogStreamRequestContent()
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.UpdateLogStreamRequestContent{}
    mgmt.LogStreams.Update(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.UpdateLogStreamRequestContent;

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

        client.logStreams().update(
            "id",
            UpdateLogStreamRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\LogStreams\Requests\UpdateLogStreamRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->logStreams->update(
    'id',
    new UpdateLogStreamRequestContent([]),
);

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.logStreams.update("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.logStreams.update("id", {});
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/log-streams/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": [
    {
      "type": "category"
    }
  ],
  "isPriority": true,
  "name": "<string>",
  "sink": {
    "httpEndpoint": "<string>",
    "httpAuthorization": "<string>",
    "httpContentType": "<string>",
    "httpCustomHeaders": [
      {
        "header": "<string>",
        "value": "<string>"
      }
    ]
  }
}
'

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

ID によるログストリームのパッチ

ログストリームを更新します。

PATCH エンドポイントの使用例

PATCH 操作では、次のフィールドを更新できます。

name
status
sink

注: eventbridge および eventgrid タイプのログストリームでは、sink は更新できません。

ログストリームの status を更新する

{
  "status": "active|paused"
}

ログストリームの name を更新する

{
  "name": "string"
}

http タイプの stream の sink プロパティを更新する

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

datadog タイプの stream の sink プロパティを更新する

{
  "sink": {
    "datadogRegion": "string",
    "datadogApiKey": "string"
  }
}

splunk タイプの stream の sink プロパティを更新する

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

sumo タイプの stream の sink プロパティを更新する

{
  "sink": {
    "sumoSourceAddress": "string"
  }
}

PATCH

https://{tenantDomain}/api/v2

log-streams

{id}

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.UpdateAsync(
            id: "id",
            request: new UpdateLogStreamRequestContent()
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.UpdateLogStreamRequestContent{}
    mgmt.LogStreams.Update(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.UpdateLogStreamRequestContent;

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

        client.logStreams().update(
            "id",
            UpdateLogStreamRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\LogStreams\Requests\UpdateLogStreamRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->logStreams->update(
    'id',
    new UpdateLogStreamRequestContent([]),
);

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.logStreams.update("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.logStreams.update("id", {});
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/log-streams/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": [
    {
      "type": "category"
    }
  ],
  "isPriority": true,
  "name": "<string>",
  "sink": {
    "httpEndpoint": "<string>",
    "httpAuthorization": "<string>",
    "httpContentType": "<string>",
    "httpCustomHeaders": [
      {
        "header": "<string>",
        "value": "<string>"
      }
    ]
  }
}
'

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

承認

Authorization

string

header

必須

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

パスパラメータ

string

必須

取得するログストリームの id

ボディ

filters

object[]

これらのフィルターに一致するログイベントのみがストリームによって配信されます。省略されている場合、または空の場合は、すべてのイベントが配信されます。

Show child attributes

isPriority

boolean

優先ログストリームの場合は true、そうでない場合は false

name

string

ログストリーム名

pii_config

object

Show child attributes

sink

object

Show child attributes

status

enum<string>

ログストリームのステータス。指定可能な値: active、paused、suspended

利用可能なオプション:

active,

paused,

suspended

レスポンス

ログストリームが更新されました

filters

object[]

これらのフィルターに一致するログイベントのみがストリームによって配信されます。省略されているか空の場合は、すべてのイベントが配信されます。

Show child attributes

string<log-stream-id>

ログストリームの ID

isPriority

boolean

優先ログストリームの場合は true、非優先の場合は false

name

string

ログストリーム名

pii_config

object

Show child attributes

sink

object

Show child attributes

status

enum<string>

ログストリームのステータス。指定可能な値: active、paused、suspended

利用可能なオプション:

active,

paused,

suspended

type

enum<string>

利用可能なオプション:

http