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. May contain lowercase alphabetical characters, numbers, underscores (_ ), and dashes (- ). Can start with a number. Must be between 1 and 50 characters. |
Display Name | User-friendly name to display. |
Field | Description |
---|---|
Organization Logo | Logo to display. Minimum recommended resolution is 200 pixels (width) by 200 pixels (height). |
Primary Color | Color for primary elements. |
Page Background Color | Color for background. |
POST
call to the Create Organizations
endpoint. Ensure you replace the placeholder values with the appropriate values from your tenant. For more details, review the parameter chart below.
.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. May contain lowercase alphabetical characters, numbers, underscores (_ ), and dashes (- ). Can start with a number. Must be between 1 and 50 characters. |
ORG_DISPLAY_NAME | Optional. User-friendly name of the organizations that can be displayed in the login flow and email templates. |
ORG_LOGO | Optional. URL of the organization’s logo. |
ORG_PRIMARY_COLOR | Optional. HEX color code for primary elements. |
ORG_BACKGROUND_COLOR | Optional. HEX color code for background. |
KEY /VALUE | Optional. String key/value pairs that represent metadata for the organization. Maximum of 255 characters each. Maximum of 25 metadata pairs. |
CONNECTION_ID | Optional. ID of the connection you want to enable for the specified organization. Enabled connections are displayed on the organization’s login prompt, so users can access your application(s) through them. |
ASSIGN_MEMBERSHIP_OPTION | Optional. Indicates whether you want users that log in with the enabled connection to automatically be granted membership in the specified organization. When set to true , users will automatically be granted membership. When set to false , they will not automatically be granted membership. |
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. |