Set rules config for a given key

Sets a rules config variable.

PUT https://{tenantDomain}/api/v2/rules-configs/{key}

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.RulesConfigs.SetAsync(
            key: "key",
            request: new SetRulesConfigRequestContent {
                Value = "value"
            }
        );
    }

}

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.SetRulesConfigRequestContent{
        Value: "value",
    }
    mgmt.RulesConfigs.Set(
        context.TODO(),
        "key",
        request,
    )
}

package com.example.usage;

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

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

        client.rulesConfigs().set(
            "key",
            SetRulesConfigRequestContent
                .builder()
                .value("value")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\RulesConfigs\Requests\SetRulesConfigRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->rulesConfigs->set(
    'key',
    new SetRulesConfigRequestContent([
        'value' => 'value',
    ]),
);

from auth0.management import ManagementClient

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

client.rules_configs.set(
    key="key",
    value="value",
)

require "auth0"

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

client.rules_configs.set(
  key: "key",
  value: "value"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.rulesConfigs.set("key", {
        value: "value",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.rulesConfigs.set("key", {
        value: "value",
    });
}
main();

curl --request PUT \
  --url https://{tenantDomain}/api/v2/rules-configs/{key} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "MY_RULES_CONFIG_VALUE"
}
'

200

{
  "key": "MY_RULES_CONFIG_KEY",
  "value": "MY_RULES_CONFIG_VALUE"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

key · string · required

Key of the rules config variable to set (max length: 127 characters).

Required string length: 1 - 127

Body

application/jsonapplication/x-www-form-urlencoded

value · string · default: MY_RULES_CONFIG_VALUE · required

Value for a rules config variable.

Response

200

application/json

Rules config variable successfully set.

key · string · default: MY_RULES_CONFIG_KEY · required

Key for a rules config variable.

Required string length: 1 - 127

Pattern: ^[A-Za-z0-9_\-@*+:]*$

value · string · default: MY_RULES_CONFIG_VALUE · required

Value for a rules config variable.