Update Organization details

Update details for this Organization, such as display name and branding options. To learn more about Auth0 Organizations, read Organizations.

PATCH /details

Update Organization details

cURL

curl --request PATCH \
  --url https://{tenantDomain}/my-org/v1/details \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "testorg",
  "display_name": "Test Organization",
  "branding": {
    "logo_url": "https://example.com/logo.png",
    "colors": {
      "primary": "#000000",
      "page_background": "#FFFFFF"
    }
  }
}
'

import requests

url = "https://{tenantDomain}/my-org/v1/details"

payload = {
    "name": "testorg",
    "display_name": "Test Organization",
    "branding": {
        "logo_url": "https://example.com/logo.png",
        "colors": {
            "primary": "#000000",
            "page_background": "#FFFFFF"
        }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'testorg',
    display_name: 'Test Organization',
    branding: {
      logo_url: 'https://example.com/logo.png',
      colors: {primary: '#000000', page_background: '#FFFFFF'}
    }
  })
};

fetch('https://{tenantDomain}/my-org/v1/details', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/my-org/v1/details",
  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([
    'name' => 'testorg',
    'display_name' => 'Test Organization',
    'branding' => [
        'logo_url' => 'https://example.com/logo.png',
        'colors' => [
                'primary' => '#000000',
                'page_background' => '#FFFFFF'
        ]
    ]
  ]),
  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;
}

package main

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

func main() {

	url := "https://{tenantDomain}/my-org/v1/details"

	payload := strings.NewReader("{\n  \"name\": \"testorg\",\n  \"display_name\": \"Test Organization\",\n  \"branding\": {\n    \"logo_url\": \"https://example.com/logo.png\",\n    \"colors\": {\n      \"primary\": \"#000000\",\n      \"page_background\": \"#FFFFFF\"\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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))

}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/my-org/v1/details")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"testorg\",\n  \"display_name\": \"Test Organization\",\n  \"branding\": {\n    \"logo_url\": \"https://example.com/logo.png\",\n    \"colors\": {\n      \"primary\": \"#000000\",\n      \"page_background\": \"#FFFFFF\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/my-org/v1/details")

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  \"name\": \"testorg\",\n  \"display_name\": \"Test Organization\",\n  \"branding\": {\n    \"logo_url\": \"https://example.com/logo.png\",\n    \"colors\": {\n      \"primary\": \"#000000\",\n      \"page_background\": \"#FFFFFF\"\n    }\n  }\n}"

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

200

updateOrgDetailsResponseExample

{
  "id": "org_zW1UHutvkVWSWdCC",
  "name": "testorg",
  "display_name": "Test Organization",
  "branding": {
    "logo_url": "https://example.com/logo.png",
    "colors": {
      "primary": "#000000",
      "page_background": "#FFFFFF"
    }
  }
}

Authorizations

OAuth2ClientCredentialsOAuth2AuthCode

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

name · string

The name of this organization.

Required string length: 1 - 50

display_name · string

Friendly name of this organization.

Required string length: 1 - 255

branding · object

Theme defines how to style the login pages.

Show child attributes

Response

200

application/json

Organization details successfully retrieved.

id · string · read-only

Organization identifier.

Pattern: ^org_[A-Za-z0-9]{16}$

name · string

The name of this organization.

Required string length: 1 - 50

display_name · string

Friendly name of this organization.

Required string length: 1 - 255

branding · object

Theme defines how to style the login pages.

Show child attributes