Update branding settings

Update branding settings.

PATCH https://{tenantDomain}/api/v2/branding

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.UpdateBrandingRequestContent{}
    client.Branding.Update(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/branding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "colors": {
    "primary": "<string>",
    "page_background": "<string>"
  },
  "favicon_url": "<string>",
  "logo_url": "<string>",
  "font": {
    "url": "<string>"
  }
}
'

import requests

url = "https://{tenantDomain}/api/v2/branding"

payload = {
    "colors": {
        "primary": "<string>",
        "page_background": "<string>"
    },
    "favicon_url": "<string>",
    "logo_url": "<string>",
    "font": { "url": "<string>" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/branding",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'colors' => [
        'primary' => '<string>',
        'page_background' => '<string>'
    ],
    'favicon_url' => '<string>',
    'logo_url' => '<string>',
    'font' => [
        'url' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/branding")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"colors\": {\n    \"primary\": \"<string>\",\n    \"page_background\": \"<string>\"\n  },\n  \"favicon_url\": \"<string>\",\n  \"logo_url\": \"<string>\",\n  \"font\": {\n    \"url\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/branding")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"colors\": {\n    \"primary\": \"<string>\",\n    \"page_background\": \"<string>\"\n  },\n  \"favicon_url\": \"<string>\",\n  \"logo_url\": \"<string>\",\n  \"font\": {\n    \"url\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "colors": {
    "primary": "<string>",
    "page_background": "<string>"
  },
  "favicon_url": "<string>",
  "logo_url": "<string>",
  "font": {
    "url": "<string>"
  }
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

Branding settings

colors · object | null

Custom color settings.

Show child attributes

favicon_url · string<strict-https-uri-or-null> | null

URL for the favicon. Must use HTTPS.

logo_url · string<strict-https-uri-or-null> | null

URL for the logo. Must use HTTPS.

font · object | null

Custom font settings.

Show child attributes

レスポンス

200

application/json

Branding settings successfully updated.

colors · object

Custom color settings.

Show child attributes

favicon_url · string<strict-https-uri>

URL for the favicon. Must use HTTPS.

logo_url · string<strict-https-uri>

URL for the logo. Must use HTTPS.

font · object

Custom font settings.

Show child attributes