Create Organizations

You can create organizations using either the Auth0 Dashboard or the Management API.

Auth0 Dashboard

To create an organization via the Auth0 Dashboard:

  1. Navigate to Auth0 Dashboard > Organizations.

  2. Select Create Organization.

  3. Enter basic information for your organization, and select Add Organization:

    Field Description
    Name Name of the organization you would like to create. This is the name that an end-user would type in the pre-login prompt to identify which organization they wanted to log in through. Unique logical identifier, which cannot be changed. May contain lowercase alphabetical characters, numbers, underscores (_), and dashes (-). Can start with a number. Must be between 3 and 50 characters.
    Display Name User-friendly name to display.

  4. Locate the Branding section and customize your organization, then select Save changes:

    Field Description
    Organization Logo Logo to display.
    Primary Color Color for primary elements.
    Page Background Color Color for background.

  5. Locate the Metadata section and add any necessary metadata key/value pairs to the organization, then select Add.

Management API

To create an organization via the Management API:

Make a POST call to the Create Organizations endpoint. Be sure to replace MGMT_API_ACCESS_TOKEN, ORG_NAME, ORG_DISPLAY_NAME, ORG_LOGO, ORG_PRIMARY_COLOR, ORG_BACKGROUND_COLOR, and KEY/VALUE placeholder values with your Management API Access Token, organization name, organization display name, organization logo, organization primary color, organization background color, and organization metadata keys and values, respectively.


curl --request POST \
  --url https://your_auth0_domain/api/v2/organizations \
  --header 'authorization: Bearer MGMT_API_ACCESS_TOKEN' \
  --header 'cache-control: no-cache' \
  --header 'content-type: application/json' \
  --data '{ "name": "ORG_NAME", "display_name": "ORG_DISPLAY_NAME", "branding": [ { "logo_url": "ORG_LOGO", "colors": [ { "primary": "ORG_PRIMARY_COLOR", "page_background": "ORG_PAGE_BACKGROUND" } ] } ], "metadata": [ { "KEY": "VALUE", "KEY": "VALUE", "KEY": "VALUE" } ] }'
var client = new RestClient("https://your_auth0_domain/api/v2/organizations");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "Bearer MGMT_API_ACCESS_TOKEN");
request.AddHeader("cache-control", "no-cache");
request.AddParameter("application/json", "{ \"name\": \"ORG_NAME\", \"display_name\": \"ORG_DISPLAY_NAME\", \"branding\": [ { \"logo_url\": \"ORG_LOGO\", \"colors\": [ { \"primary\": \"ORG_PRIMARY_COLOR\", \"page_background\": \"ORG_PAGE_BACKGROUND\" } ] } ], \"metadata\": [ { \"KEY\": \"VALUE\", \"KEY\": \"VALUE\", \"KEY\": \"VALUE\" } ] }", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
package main

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

func main() {

	url := "https://your_auth0_domain/api/v2/organizations"

	payload := strings.NewReader("{ \"name\": \"ORG_NAME\", \"display_name\": \"ORG_DISPLAY_NAME\", \"branding\": [ { \"logo_url\": \"ORG_LOGO\", \"colors\": [ { \"primary\": \"ORG_PRIMARY_COLOR\", \"page_background\": \"ORG_PAGE_BACKGROUND\" } ] } ], \"metadata\": [ { \"KEY\": \"VALUE\", \"KEY\": \"VALUE\", \"KEY\": \"VALUE\" } ] }")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer MGMT_API_ACCESS_TOKEN")
	req.Header.Add("cache-control", "no-cache")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://your_auth0_domain/api/v2/organizations")
  .header("content-type", "application/json")
  .header("authorization", "Bearer MGMT_API_ACCESS_TOKEN")
  .header("cache-control", "no-cache")
  .body("{ \"name\": \"ORG_NAME\", \"display_name\": \"ORG_DISPLAY_NAME\", \"branding\": [ { \"logo_url\": \"ORG_LOGO\", \"colors\": [ { \"primary\": \"ORG_PRIMARY_COLOR\", \"page_background\": \"ORG_PAGE_BACKGROUND\" } ] } ], \"metadata\": [ { \"KEY\": \"VALUE\", \"KEY\": \"VALUE\", \"KEY\": \"VALUE\" } ] }")
  .asString();
var axios = require("axios").default;

var options = {
  method: 'POST',
  url: 'https://your_auth0_domain/api/v2/organizations',
  headers: {
    'content-type': 'application/json',
    authorization: 'Bearer MGMT_API_ACCESS_TOKEN',
    'cache-control': 'no-cache'
  },
  data: {
    name: 'ORG_NAME',
    display_name: 'ORG_DISPLAY_NAME',
    branding: [
      {
        logo_url: 'ORG_LOGO',
        colors: [{primary: 'ORG_PRIMARY_COLOR', page_background: 'ORG_PAGE_BACKGROUND'}]
      }
    ],
    metadata: [{KEY: 'VALUE'}]
  }
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});
#import <Foundation/Foundation.h>

NSDictionary *headers = @{ @"content-type": @"application/json",
                           @"authorization": @"Bearer MGMT_API_ACCESS_TOKEN",
                           @"cache-control": @"no-cache" };
NSDictionary *parameters = @{ @"name": @"ORG_NAME",
                              @"display_name": @"ORG_DISPLAY_NAME",
                              @"branding": @[ @{ @"logo_url": @"ORG_LOGO", @"colors": @[ @{ @"primary": @"ORG_PRIMARY_COLOR", @"page_background": @"ORG_PAGE_BACKGROUND" } ] } ],
                              @"metadata": @[ @{ @"KEY": @"VALUE" } ] };

NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];

NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://your_auth0_domain/api/v2/organizations"]
                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy
                                                   timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
                                            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
                                                if (error) {
                                                    NSLog(@"%@", error);
                                                } else {
                                                    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
                                                    NSLog(@"%@", httpResponse);
                                                }
                                            }];
[dataTask resume];
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://your_auth0_domain/api/v2/organizations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{ \"name\": \"ORG_NAME\", \"display_name\": \"ORG_DISPLAY_NAME\", \"branding\": [ { \"logo_url\": \"ORG_LOGO\", \"colors\": [ { \"primary\": \"ORG_PRIMARY_COLOR\", \"page_background\": \"ORG_PAGE_BACKGROUND\" } ] } ], \"metadata\": [ { \"KEY\": \"VALUE\", \"KEY\": \"VALUE\", \"KEY\": \"VALUE\" } ] }",
  CURLOPT_HTTPHEADER => [
    "authorization: Bearer MGMT_API_ACCESS_TOKEN",
    "cache-control: no-cache",
    "content-type: application/json"
  ],
]);

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

curl_close($curl);

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

conn = http.client.HTTPSConnection("your_auth0_domain")

payload = "{ \"name\": \"ORG_NAME\", \"display_name\": \"ORG_DISPLAY_NAME\", \"branding\": [ { \"logo_url\": \"ORG_LOGO\", \"colors\": [ { \"primary\": \"ORG_PRIMARY_COLOR\", \"page_background\": \"ORG_PAGE_BACKGROUND\" } ] } ], \"metadata\": [ { \"KEY\": \"VALUE\", \"KEY\": \"VALUE\", \"KEY\": \"VALUE\" } ] }"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer MGMT_API_ACCESS_TOKEN",
    'cache-control': "no-cache"
    }

conn.request("POST", "/api/v2/organizations", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://your_auth0_domain/api/v2/organizations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request["authorization"] = 'Bearer MGMT_API_ACCESS_TOKEN'
request["cache-control"] = 'no-cache'
request.body = "{ \"name\": \"ORG_NAME\", \"display_name\": \"ORG_DISPLAY_NAME\", \"branding\": [ { \"logo_url\": \"ORG_LOGO\", \"colors\": [ { \"primary\": \"ORG_PRIMARY_COLOR\", \"page_background\": \"ORG_PAGE_BACKGROUND\" } ] } ], \"metadata\": [ { \"KEY\": \"VALUE\", \"KEY\": \"VALUE\", \"KEY\": \"VALUE\" } ] }"

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

let headers = [
  "content-type": "application/json",
  "authorization": "Bearer MGMT_API_ACCESS_TOKEN",
  "cache-control": "no-cache"
]
let parameters = [
  "name": "ORG_NAME",
  "display_name": "ORG_DISPLAY_NAME",
  "branding": [
    [
      "logo_url": "ORG_LOGO",
      "colors": [
        [
          "primary": "ORG_PRIMARY_COLOR",
          "page_background": "ORG_PAGE_BACKGROUND"
        ]
      ]
    ]
  ],
  "metadata": [["KEY": "VALUE"]]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://your_auth0_domain/api/v2/organizations")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

Find Your Auth0 Domain

If your Auth0 domain is your tenant name, your regional subdomain (unless your tenant is in the US region and was created before June 2020), plus .auth0.com. For example, if your tenant name were travel0, your Auth0 domain name would be travel0.us.auth0.com. (If your tenant were in the US and created before June 2020, then your domain name would be https://travel0.auth0.com.)

If you are using custom domains, this should be your custom domain name.

Value Description
MGMT_API_ACCESS_TOKEN Access Token for the Management API with the scope create:organizations.
ORG_NAME Name of the organization you would like to create. This is the name that an end-user would type in the pre-login prompt to identify which organization they wanted to log in through. Unique logical identifier, which cannot be changed. May contain lowercase alphabetical characters, numbers, underscores (_), and dashes (-). Can start with a number. Must be between 3 and 50 characters.
ORG_DISPLAY_NAME User-friendly name of the organizations that can be displayed in the login flow and email templates.
ORG_LOGO URL of the organization’s logo.
ORG_PRIMARY_COLOR HEX color code for primary elements.
ORG_BACKGROUND_COLOR HEX color code for background.
KEY/VALUE String key/value pairs that represent metadata for the organization. Maximum of 255 characters each. Maximum of 10 metadata pairs.

Response status codes

Possible response status codes are as follows:

Status code Error code Message Cause
201 Organization successfully created.
400 invalid_body Invalid request body. The message will vary depending on the cause. The request payload is not valid.
400 invalid_query_string Invalid request query string. The message will vary depending on the cause. The query string is not valid.
401 Invalid token.
401 Invalid signature received for JSON Web Token validation.
401 Client is not global.
403 insufficient_scope Insufficient scope; expected any of: create:organizations. Tried to read/write a field that is not allowed with provided bearer token scopes.
409 organization_conflict An organization with the same name already exists. An organization with the same name already exists.
429 Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.