TypeScript
import { MyOrganizationClient } from "@auth0/myorganization-js";
async function main() {
const client = new MyOrganizationClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.organizationDetails.update({
name: "testorg",
display_name: "Test Organization",
branding: {
logo_url: "https://example.com/logo.png",
colors: {
primary: "#000000",
page_background: "#FFFFFF",
},
},
});
}
main();import { MyOrganizationClient } from "@auth0/myorganization-js";
async function main() {
const client = new MyOrganizationClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.organizationDetails.update({
name: "testorg",
display_name: "Test Organization",
branding: {
logo_url: "https://example.com/logo.png",
colors: {
primary: "#000000",
page_background: "#FFFFFF",
},
},
});
}
main();
package example
import (
context "context"
myorganization "github.com/auth0/myorganization-go/v2"
client "github.com/auth0/myorganization-go/v2/client"
option "github.com/auth0/myorganization-go/v2/option"
)
func do() {
c, err := client.New(
"{YOUR_DOMAIN}",
option.WithToken(
"<token>",
),
)
if err != nil {
return
}
request := &myorganization.OrgDetails{
Name: myorganization.String(
"testorg",
),
DisplayName: myorganization.String(
"Test Organization",
),
Branding: &myorganization.OrgBranding{
LogoURL: myorganization.String(
"https://example.com/logo.png",
),
Colors: &myorganization.OrgBrandingColors{
Primary: "#000000",
PageBackground: "#FFFFFF",
},
},
}
c.OrganizationDetails.Update(
context.TODO(),
request,
)
}
using Auth0.MyOrganizationApi;
using System.Threading.Tasks;
public partial class Examples
{
public async Task Example() {
var client = new MyOrganizationClient(new MyOrganizationClientOptions
{
Domain = "{YOUR_DOMAIN}",
TokenProvider = new DelegateTokenProvider(_ => Task.FromResult("<token>"))
});
await client.OrganizationDetails.UpdateAsync(
new OrgDetails {
Name = "testorg",
DisplayName = "Test Organization",
Branding = new OrgBranding {
LogoUrl = "https://example.com/logo.png",
Colors = new OrgBrandingColors {
Primary = "#000000",
PageBackground = "#FFFFFF"
}
}
}
);
}
}
package com.example.usage;
import com.auth0.client.myorganization.auth.MyOrganizationClient;
import com.auth0.client.myorganization.types.OrgBranding;
import com.auth0.client.myorganization.types.OrgBrandingColors;
import com.auth0.client.myorganization.types.OrgDetails;
public class Example {
public static void main(String[] args) {
MyOrganizationClient client = MyOrganizationClient
.builder()
.domain("{YOUR_DOMAIN}")
.token("<token>")
.build();
client.organizationDetails().update(
OrgDetails
.builder()
.name("testorg")
.displayName("Test Organization")
.branding(
OrgBranding
.builder()
.logoUrl("https://example.com/logo.png")
.colors(
OrgBrandingColors
.builder()
.primary("#000000")
.pageBackground("#FFFFFF")
.build()
)
.build()
)
.build()
);
}
}from auth0.myorganization import MyOrganizationClient, OrgBranding, OrgBrandingColors
client = MyOrganizationClient(
domain="{YOUR_DOMAIN}",
token="<token>",
)
client.organization_details.update(
name="testorg",
display_name="Test Organization",
branding=OrgBranding(
logo_url="https://example.com/logo.png",
colors=OrgBrandingColors(
primary="#000000",
page_background="#FFFFFF",
),
),
)
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"
}
}
}
'<?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;
}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{
"id": "org_zW1UHutvkVWSWdCC",
"name": "testorg",
"display_name": "Test Organization",
"branding": {
"logo_url": "https://example.com/logo.png",
"colors": {
"primary": "#000000",
"page_background": "#FFFFFF"
}
}
}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
TypeScript
import { MyOrganizationClient } from "@auth0/myorganization-js";
async function main() {
const client = new MyOrganizationClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.organizationDetails.update({
name: "testorg",
display_name: "Test Organization",
branding: {
logo_url: "https://example.com/logo.png",
colors: {
primary: "#000000",
page_background: "#FFFFFF",
},
},
});
}
main();import { MyOrganizationClient } from "@auth0/myorganization-js";
async function main() {
const client = new MyOrganizationClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.organizationDetails.update({
name: "testorg",
display_name: "Test Organization",
branding: {
logo_url: "https://example.com/logo.png",
colors: {
primary: "#000000",
page_background: "#FFFFFF",
},
},
});
}
main();
package example
import (
context "context"
myorganization "github.com/auth0/myorganization-go/v2"
client "github.com/auth0/myorganization-go/v2/client"
option "github.com/auth0/myorganization-go/v2/option"
)
func do() {
c, err := client.New(
"{YOUR_DOMAIN}",
option.WithToken(
"<token>",
),
)
if err != nil {
return
}
request := &myorganization.OrgDetails{
Name: myorganization.String(
"testorg",
),
DisplayName: myorganization.String(
"Test Organization",
),
Branding: &myorganization.OrgBranding{
LogoURL: myorganization.String(
"https://example.com/logo.png",
),
Colors: &myorganization.OrgBrandingColors{
Primary: "#000000",
PageBackground: "#FFFFFF",
},
},
}
c.OrganizationDetails.Update(
context.TODO(),
request,
)
}
using Auth0.MyOrganizationApi;
using System.Threading.Tasks;
public partial class Examples
{
public async Task Example() {
var client = new MyOrganizationClient(new MyOrganizationClientOptions
{
Domain = "{YOUR_DOMAIN}",
TokenProvider = new DelegateTokenProvider(_ => Task.FromResult("<token>"))
});
await client.OrganizationDetails.UpdateAsync(
new OrgDetails {
Name = "testorg",
DisplayName = "Test Organization",
Branding = new OrgBranding {
LogoUrl = "https://example.com/logo.png",
Colors = new OrgBrandingColors {
Primary = "#000000",
PageBackground = "#FFFFFF"
}
}
}
);
}
}
package com.example.usage;
import com.auth0.client.myorganization.auth.MyOrganizationClient;
import com.auth0.client.myorganization.types.OrgBranding;
import com.auth0.client.myorganization.types.OrgBrandingColors;
import com.auth0.client.myorganization.types.OrgDetails;
public class Example {
public static void main(String[] args) {
MyOrganizationClient client = MyOrganizationClient
.builder()
.domain("{YOUR_DOMAIN}")
.token("<token>")
.build();
client.organizationDetails().update(
OrgDetails
.builder()
.name("testorg")
.displayName("Test Organization")
.branding(
OrgBranding
.builder()
.logoUrl("https://example.com/logo.png")
.colors(
OrgBrandingColors
.builder()
.primary("#000000")
.pageBackground("#FFFFFF")
.build()
)
.build()
)
.build()
);
}
}from auth0.myorganization import MyOrganizationClient, OrgBranding, OrgBrandingColors
client = MyOrganizationClient(
domain="{YOUR_DOMAIN}",
token="<token>",
)
client.organization_details.update(
name="testorg",
display_name="Test Organization",
branding=OrgBranding(
logo_url="https://example.com/logo.png",
colors=OrgBrandingColors(
primary="#000000",
page_background="#FFFFFF",
),
),
)
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"
}
}
}
'<?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;
}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{
"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
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
The name of this organization.
Required string length:
1 - 50Friendly name of this organization.
Required string length:
1 - 255Theme defines how to style the login pages.
Show child attributes
Show child attributes
A valid third-party client access value
Available options:
allow, block Response
Organization details successfully retrieved.
Organization identifier.
Pattern:
^org_[A-Za-z0-9]{16}$The name of this organization.
Required string length:
1 - 50Friendly name of this organization.
Required string length:
1 - 255Theme defines how to style the login pages.
Show child attributes
Show child attributes
A valid third-party client access value
Available options:
allow, block