セグメントを更新する。

TypeScript

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

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.UpdateSegmentRequestContent{}
    mgmt.Experimentation.Segments.Update(
        context.TODO(),
        "id",
        request,
    )
}

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

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

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.experimentation.types.UpdateSegmentRequestContent;

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

        client.experimentation().segments().update(
            "id",
            UpdateSegmentRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Experimentation\Segments\Requests\UpdateSegmentRequestContent;

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

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/experimentation/segments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "rules": [
    {
      "match": {
        "client_id": [
          "<string>"
        ],
        "connection": [
          "<string>"
        ],
        "connection_type": [
          "<string>"
        ],
        "organization_id": [
          "<string>"
        ],
        "domain": [
          "<string>"
        ],
        "device_type": [
          "<string>"
        ],
        "browser": [
          "<string>"
        ],
        "platform": [
          "<string>"
        ],
        "user_agent": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "region": [
          "<string>"
        ]
      },
      "not_match": {
        "client_id": [
          "<string>"
        ],
        "connection": [
          "<string>"
        ],
        "connection_type": [
          "<string>"
        ],
        "organization_id": [
          "<string>"
        ],
        "domain": [
          "<string>"
        ],
        "device_type": [
          "<string>"
        ],
        "browser": [
          "<string>"
        ],
        "platform": [
          "<string>"
        ],
        "user_agent": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "region": [
          "<string>"
        ]
      }
    }
  ]
}
'

{
  "id": "<string>",
  "name": "<string>",
  "type": "self",
  "status": "active",
  "rules": [
    {
      "match": {
        "client_id": [
          "<string>"
        ],
        "connection": [
          "<string>"
        ],
        "connection_type": [
          "<string>"
        ],
        "organization_id": [
          "<string>"
        ],
        "domain": [
          "<string>"
        ],
        "device_type": [
          "<string>"
        ],
        "browser": [
          "<string>"
        ],
        "platform": [
          "<string>"
        ],
        "user_agent": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "region": [
          "<string>"
        ]
      },
      "not_match": {
        "client_id": [
          "<string>"
        ],
        "connection": [
          "<string>"
        ],
        "connection_type": [
          "<string>"
        ],
        "organization_id": [
          "<string>"
        ],
        "domain": [
          "<string>"
        ],
        "device_type": [
          "<string>"
        ],
        "browser": [
          "<string>"
        ],
        "platform": [
          "<string>"
        ],
        "user_agent": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "region": [
          "<string>"
        ]
      }
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>"
}

PATCH

https://{tenantDomain}/api/v2

experimentation

segments

{id}

TypeScript

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

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.UpdateSegmentRequestContent{}
    mgmt.Experimentation.Segments.Update(
        context.TODO(),
        "id",
        request,
    )
}

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

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

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.experimentation.types.UpdateSegmentRequestContent;

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

        client.experimentation().segments().update(
            "id",
            UpdateSegmentRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Experimentation\Segments\Requests\UpdateSegmentRequestContent;

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

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/experimentation/segments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "rules": [
    {
      "match": {
        "client_id": [
          "<string>"
        ],
        "connection": [
          "<string>"
        ],
        "connection_type": [
          "<string>"
        ],
        "organization_id": [
          "<string>"
        ],
        "domain": [
          "<string>"
        ],
        "device_type": [
          "<string>"
        ],
        "browser": [
          "<string>"
        ],
        "platform": [
          "<string>"
        ],
        "user_agent": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "region": [
          "<string>"
        ]
      },
      "not_match": {
        "client_id": [
          "<string>"
        ],
        "connection": [
          "<string>"
        ],
        "connection_type": [
          "<string>"
        ],
        "organization_id": [
          "<string>"
        ],
        "domain": [
          "<string>"
        ],
        "device_type": [
          "<string>"
        ],
        "browser": [
          "<string>"
        ],
        "platform": [
          "<string>"
        ],
        "user_agent": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "region": [
          "<string>"
        ]
      }
    }
  ]
}
'

{
  "id": "<string>",
  "name": "<string>",
  "type": "self",
  "status": "active",
  "rules": [
    {
      "match": {
        "client_id": [
          "<string>"
        ],
        "connection": [
          "<string>"
        ],
        "connection_type": [
          "<string>"
        ],
        "organization_id": [
          "<string>"
        ],
        "domain": [
          "<string>"
        ],
        "device_type": [
          "<string>"
        ],
        "browser": [
          "<string>"
        ],
        "platform": [
          "<string>"
        ],
        "user_agent": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "region": [
          "<string>"
        ]
      },
      "not_match": {
        "client_id": [
          "<string>"
        ],
        "connection": [
          "<string>"
        ],
        "connection_type": [
          "<string>"
        ],
        "organization_id": [
          "<string>"
        ],
        "domain": [
          "<string>"
        ],
        "device_type": [
          "<string>"
        ],
        "browser": [
          "<string>"
        ],
        "platform": [
          "<string>"
        ],
        "user_agent": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "region": [
          "<string>"
        ]
      }
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>"
}

承認

Authorization

string

header

必須

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

パスパラメータ

string

必須

更新するセグメントの ID。

ボディ

セグメントの部分更新。指定されたフィールドのみ更新されます。rulesを送信すると、rules配列全体が置き換えられます。

name

string

セグメントの表示名

Required string length: 3 - 255

Pattern: ^(?!.*\x00)\S(.*\S)?$

description

string | null

セグメントの説明

Required string length: 3 - 1024

Pattern: ^(?!.*\x00)\S(.*\S)?$

rules

object[]

ルール配列全体を置き換えます。各ルールは4KB、セグメント全体は10KB（シリアル化後）に制限されます。

Minimum array length: 1

Show child attributes

status

enum<string>

遷移先のライフサイクル状態。アーカイブすると、セグメントは有効なセグメントの集合から除外され、最終状態になります（アーカイブ済みのセグメントは有効な状態に戻せません）。フィールドの編集と組み合わせる場合、編集が先に適用され、その後に遷移が行われます。

利用可能なオプション:

active,

archived

レスポンス

セグメントを正常に更新しました。

string

必須

Pattern: ^seg_[A-HJ-NP-Za-km-z1-9]+$

name

string

必須

type

enum<string>

必須

利用可能なオプション:

self,

auth0

status

enum<string>

必須

利用可能なオプション:

active,

archived

rules

object[]

必須

Show child attributes

created_at

string<date-time>

必須

updated_at

string<date-time>

必須

description

string