Transition an experiment to a new status.

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.UpdateStatusAsync(
            id: "id",
            request: new UpdateExperimentStatusRequestContent {
                Status = ExperimentTransitionStatusEnum.Active
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.experimentation.types.UpdateExperimentStatusRequestContent;
import com.auth0.client.mgmt.types.ExperimentTransitionStatusEnum;

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

        client.experimentation().experiments().updateStatus(
            "id",
            UpdateExperimentStatusRequestContent
                .builder()
                .status(ExperimentTransitionStatusEnum.ACTIVE)
                .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\UpdateExperimentStatusRequestContent;
use Auth0\SDK\API\Management\Types\ExperimentTransitionStatusEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->experimentation->experiments->updateStatus(
    'id',
    new UpdateExperimentStatusRequestContent([
        'status' => ExperimentTransitionStatusEnum::Active->value,
    ]),
);

from auth0.management import ManagementClient

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

client.experimentation.experiments.update_status(
    id="id",
    status="active",
)

curl --request POST \
  --url https://{tenantDomain}/api/v2/experimentation/experiments/{id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://{tenantDomain}/api/v2/experimentation/experiments/{id}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/experimentation/experiments/{id}/status"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "<string>",
  "name": "<string>",
  "feature_flag_id": "<string>",
  "authentication_flow": "<string>",
  "allocation_strategy": "percentage",
  "assignment_config": {
    "subject": "device"
  },
  "status": "draft",
  "is_valid": true,
  "allocations": [
    {
      "variation_id": "<string>",
      "segment_id": "<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>",
  "is_stateful": true,
  "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

{id}

status

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.UpdateStatusAsync(
            id: "id",
            request: new UpdateExperimentStatusRequestContent {
                Status = ExperimentTransitionStatusEnum.Active
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.experimentation.types.UpdateExperimentStatusRequestContent;
import com.auth0.client.mgmt.types.ExperimentTransitionStatusEnum;

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

        client.experimentation().experiments().updateStatus(
            "id",
            UpdateExperimentStatusRequestContent
                .builder()
                .status(ExperimentTransitionStatusEnum.ACTIVE)
                .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\UpdateExperimentStatusRequestContent;
use Auth0\SDK\API\Management\Types\ExperimentTransitionStatusEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->experimentation->experiments->updateStatus(
    'id',
    new UpdateExperimentStatusRequestContent([
        'status' => ExperimentTransitionStatusEnum::Active->value,
    ]),
);

from auth0.management import ManagementClient

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

client.experimentation.experiments.update_status(
    id="id",
    status="active",
)

curl --request POST \
  --url https://{tenantDomain}/api/v2/experimentation/experiments/{id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://{tenantDomain}/api/v2/experimentation/experiments/{id}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/experimentation/experiments/{id}/status"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "<string>",
  "name": "<string>",
  "feature_flag_id": "<string>",
  "authentication_flow": "<string>",
  "allocation_strategy": "percentage",
  "assignment_config": {
    "subject": "device"
  },
  "status": "draft",
  "is_valid": true,
  "allocations": [
    {
      "variation_id": "<string>",
      "segment_id": "<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>",
  "is_stateful": true,
  "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.

パスパラメータ

string

必須

The ID of the experiment to transition.

ボディ

The target lifecycle status for the experiment.

status

enum<string>

必須

The target status to transition the experiment to.

利用可能なオプション:

active,

paused,

completed,

archived

レスポンス

Experiment status successfully updated.

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

assignment_config

object

必須

Show child attributes

status

enum<string>

必須

Filter by status. Exact match.

利用可能なオプション:

draft,

active,

paused,

completed,

archived

is_valid

boolean

必須

allocations

object[]

必須

Show child attributes

editable_fields

string[]

必須

Fields that may be mutated given the experiment's current status. Computed at response time; always current with the API's enforcement logic.

created_at

string<date-time>

必須

updated_at

string<date-time>

必須

description

string

is_stateful

boolean

feature_flag_snapshot

object | null

levels

integer[]

Ramp experiment levels configuration.

current_level

integer | null

Read-only. The active exposure percentage for the current ramp step. Null when no ramp schedule is active.

started_at

string<date-time>

ended_at

string<date-time>