Experiment Center の実験を作成します。

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.experimentation.experiments.create({
        name: "name",
        feature_flag_id: "feature_flag_id",
        authentication_flow: "authentication",
        allocation_strategy: "percentage",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.experimentation.experiments.create({
        name: "name",
        feature_flag_id: "feature_flag_id",
        authentication_flow: "authentication",
        allocation_strategy: "percentage",
    });
}
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.CreateExperimentRequestContent{
        Name: "name",
        FeatureFlagID: "feature_flag_id",
        AuthenticationFlow: management.AuthenticationFlowEnumAuthentication,
        AllocationStrategy: management.AllocationStrategyEnumPercentage,
    }
    mgmt.Experimentation.Experiments.Create(
        context.TODO(),
        request,
    )
}

# Ensure you're logged in: auth0 login
auth0 api post "experimentation/experiments" --data '{
  "name": "name",
  "feature_flag_id": "feature_flag_id",
  "authentication_flow": "authentication",
  "allocation_strategy": "percentage"
}'

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.Experiments.CreateAsync(
            new CreateExperimentRequestContent {
                Name = "name",
                FeatureFlagId = "feature_flag_id",
                AuthenticationFlow = AuthenticationFlowEnum.Authentication,
                AllocationStrategy = AllocationStrategyEnum.Percentage
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.experimentation.types.CreateExperimentRequestContent;
import com.auth0.client.mgmt.types.AllocationStrategyEnum;
import com.auth0.client.mgmt.types.AuthenticationFlowEnum;

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

        client.experimentation().experiments().create(
            CreateExperimentRequestContent
                .builder()
                .name("name")
                .featureFlagId("feature_flag_id")
                .authenticationFlow(AuthenticationFlowEnum.AUTHENTICATION)
                .allocationStrategy(AllocationStrategyEnum.PERCENTAGE)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Experimentation\Experiments\Requests\CreateExperimentRequestContent;
use Auth0\SDK\API\Management\Types\AuthenticationFlowEnum;
use Auth0\SDK\API\Management\Types\AllocationStrategyEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->experimentation->experiments->create(
    new CreateExperimentRequestContent([
        'name' => 'name',
        'featureFlagId' => 'feature_flag_id',
        'authenticationFlow' => AuthenticationFlowEnum::Authentication->value,
        'allocationStrategy' => AllocationStrategyEnum::Percentage->value,
    ]),
);

from auth0.management import ManagementClient

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

client.experimentation.experiments.create(
    name="name",
    feature_flag_id="feature_flag_id",
    authentication_flow="authentication",
    allocation_strategy="percentage",
)

require "auth0"

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

client.experimentation.experiments.create(
  name: "name",
  feature_flag_id: "feature_flag_id",
  authentication_flow: "authentication",
  allocation_strategy: "percentage"
)

curl --request POST \
  --url https://{tenantDomain}/api/v2/experimentation/experiments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "feature_flag_id": "<string>",
  "description": "<string>",
  "allocations": [
    {
      "variation_id": "<string>",
      "is_control": true,
      "weight": 50,
      "segment_id": "<string>",
      "priority": 2,
      "is_fallback": true
    }
  ],
  "levels": [
    50
  ]
}
'

{
  "id": "<string>",
  "name": "<string>",
  "feature_flag_id": "<string>",
  "authentication_flow": "<string>",
  "allocation_strategy": "percentage",
  "status": "draft",
  "is_valid": true,
  "allocations": [
    {
      "variation_id": "<string>",
      "variation_name": "<string>",
      "segment_id": "<string>",
      "segment_name": "<string>",
      "weight": 123,
      "priority": 123,
      "is_control": true,
      "is_fallback": true,
      "variation_snapshot": {},
      "segment_snapshot": {}
    }
  ],
  "editable_fields": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "feature_flag_name": "<string>",
  "default_config": "tenant",
  "feature_flag_snapshot": {},
  "levels": [
    123
  ],
  "current_level": 123,
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z"
}

POST

https://{tenantDomain}/api/v2

experimentation

experiments

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.experimentation.experiments.create({
        name: "name",
        feature_flag_id: "feature_flag_id",
        authentication_flow: "authentication",
        allocation_strategy: "percentage",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.experimentation.experiments.create({
        name: "name",
        feature_flag_id: "feature_flag_id",
        authentication_flow: "authentication",
        allocation_strategy: "percentage",
    });
}
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.CreateExperimentRequestContent{
        Name: "name",
        FeatureFlagID: "feature_flag_id",
        AuthenticationFlow: management.AuthenticationFlowEnumAuthentication,
        AllocationStrategy: management.AllocationStrategyEnumPercentage,
    }
    mgmt.Experimentation.Experiments.Create(
        context.TODO(),
        request,
    )
}

# Ensure you're logged in: auth0 login
auth0 api post "experimentation/experiments" --data '{
  "name": "name",
  "feature_flag_id": "feature_flag_id",
  "authentication_flow": "authentication",
  "allocation_strategy": "percentage"
}'

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.Experiments.CreateAsync(
            new CreateExperimentRequestContent {
                Name = "name",
                FeatureFlagId = "feature_flag_id",
                AuthenticationFlow = AuthenticationFlowEnum.Authentication,
                AllocationStrategy = AllocationStrategyEnum.Percentage
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.experimentation.types.CreateExperimentRequestContent;
import com.auth0.client.mgmt.types.AllocationStrategyEnum;
import com.auth0.client.mgmt.types.AuthenticationFlowEnum;

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

        client.experimentation().experiments().create(
            CreateExperimentRequestContent
                .builder()
                .name("name")
                .featureFlagId("feature_flag_id")
                .authenticationFlow(AuthenticationFlowEnum.AUTHENTICATION)
                .allocationStrategy(AllocationStrategyEnum.PERCENTAGE)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Experimentation\Experiments\Requests\CreateExperimentRequestContent;
use Auth0\SDK\API\Management\Types\AuthenticationFlowEnum;
use Auth0\SDK\API\Management\Types\AllocationStrategyEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->experimentation->experiments->create(
    new CreateExperimentRequestContent([
        'name' => 'name',
        'featureFlagId' => 'feature_flag_id',
        'authenticationFlow' => AuthenticationFlowEnum::Authentication->value,
        'allocationStrategy' => AllocationStrategyEnum::Percentage->value,
    ]),
);

from auth0.management import ManagementClient

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

client.experimentation.experiments.create(
    name="name",
    feature_flag_id="feature_flag_id",
    authentication_flow="authentication",
    allocation_strategy="percentage",
)

require "auth0"

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

client.experimentation.experiments.create(
  name: "name",
  feature_flag_id: "feature_flag_id",
  authentication_flow: "authentication",
  allocation_strategy: "percentage"
)

curl --request POST \
  --url https://{tenantDomain}/api/v2/experimentation/experiments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "feature_flag_id": "<string>",
  "description": "<string>",
  "allocations": [
    {
      "variation_id": "<string>",
      "is_control": true,
      "weight": 50,
      "segment_id": "<string>",
      "priority": 2,
      "is_fallback": true
    }
  ],
  "levels": [
    50
  ]
}
'

{
  "id": "<string>",
  "name": "<string>",
  "feature_flag_id": "<string>",
  "authentication_flow": "<string>",
  "allocation_strategy": "percentage",
  "status": "draft",
  "is_valid": true,
  "allocations": [
    {
      "variation_id": "<string>",
      "variation_name": "<string>",
      "segment_id": "<string>",
      "segment_name": "<string>",
      "weight": 123,
      "priority": 123,
      "is_control": true,
      "is_fallback": true,
      "variation_snapshot": {},
      "segment_snapshot": {}
    }
  ],
  "editable_fields": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "feature_flag_name": "<string>",
  "default_config": "tenant",
  "feature_flag_snapshot": {},
  "levels": [
    123
  ],
  "current_level": 123,
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z"
}

承認

Authorization

string

header

必須

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

ボディ

トラフィック割り当てを含む実験を作成

name

string

必須

実験のわかりやすい名前

Required string length: 3 - 255

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

feature_flag_id

string

必須

この実験の基となる機能フラグの ID

Pattern: ^flg_[A-Za-z0-9_]+$

authentication_flow

enum<string>

必須

この実験の対象となる認証フローを指定します。次のいずれかである必要があります: authentication, mfa_enrollment, mfa_challenge, password_reset, passkey_enrollment, または all。all はすべてのフローを一度に対象としますが、これが唯一のアクティブな実験である必要があります。

利用可能なオプション:

authentication,

mfa_enrollment,

mfa_challenge,

password_reset,

passkey_enrollment,

all

allocation_strategy

enum<string>

必須

この実験のトラフィック割り当て戦略

利用可能なオプション:

percentage,

segment

description

string

実験の説明

Required string length: 3 - 1024

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

default_config

enum<string>

Auth0が管理するフラグにのみ適用されます。上書きされていない設定キーの値をどこから取得するかを指定します。'tenant' はテナントの現在の設定を継承し、実験による変更分だけを上書きします。'flag' はフラグの固定された既定値を使用して、設定全体を構成します。省略可能で、省略した場合の既定値は 'tenant' です。顧客が定義したフラグには指定できません。

利用可能なオプション:

tenant,

flag

allocations

object[]

variation を重みまたはセグメントに対応付けるトラフィック割り当て

Minimum array length: 1

Show child attributes

levels

integer[]

ランプ実験レベルの設定。各要素が [0, 100] の整数である、厳密に昇順の露出率の列。

Minimum array length: 1

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

レスポンス

実験が正常に作成されました。

string

必須

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

name

string

必須

feature_flag_id

string

必須

authentication_flow

string

必須

allocation_strategy

enum<string>

必須

利用可能なオプション:

percentage,

segment

status

enum<string>

必須

statusで絞り込みます。完全一致です。

利用可能なオプション:

draft,

active,

paused,

completed,

archived

is_valid

boolean

必須

最終更新時点で、エクスペリメントが妥当で、有効にする準備が整っているかどうか。その後に関連エンティティに加えられた変更は、反映されていない場合があります。最新の結果を取得するには POST /experiments/{id}/validate を呼び出してください。

allocations

object[]

必須

Show child attributes

editable_fields

string[]

必須

実験の現在のステータスに基づいて変更可能なフィールド。レスポンス時に算出され、APIの適用ロジックの最新の状態を常に反映します。

created_at

string<date-time>

必須

updated_at

string<date-time>

必須

description

string

feature_flag_name

string

default_config

enum<string>

Auth0が管理するフラグについて、上書きされていない設定キーの値をどこから取得するかを指定します。'tenant' はテナントの現在の設定を継承し、'flag' はフラグの固定された既定値を使用します。未設定の場合は省略され、設定値の取得時には 'tenant' が既定値になります。顧客が定義したフラグには適用されません。

利用可能なオプション:

tenant,

flag

feature_flag_snapshot

object | null

levels

integer[]

ランプ実験レベルの設定。

current_level

integer | null

読み取り専用。現在のランプステップにおける有効な露出率。ランプスケジュールが有効でない場合はnullです。

started_at

string<date-time>

ended_at

string<date-time>