Skip to main content
PATCH
/
organizations
/
{id}
TypeScript
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.update("id", {});
}
main();
{
  "id": "<string>",
  "name": "organization-1",
  "display_name": "Acme Users",
  "branding": {
    "logo_url": "<string>",
    "colors": {
      "primary": "<string>",
      "page_background": "<string>"
    }
  },
  "metadata": {},
  "token_quota": {
    "client_credentials": {
      "enforce": true,
      "per_day": 1073741824,
      "per_hour": 1073741824
    }
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

ID of the organization to update.

Body

display_name
string
default:Acme Users

Friendly name of this organization.

Required string length: 1 - 255
name
string<organization-name>
default:organization-1

The name of this organization.

Required string length: 1 - 50
branding
object

Theme defines how to style the login pages.

metadata
object

Metadata associated with the organization, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed.

token_quota
object

Response

Organization successfully updated.

id
string<organization-id>

Organization identifier.

Maximum string length: 50
name
string<organization-name>
default:organization-1

The name of this organization.

Required string length: 1 - 50
display_name
string
default:Acme Users

Friendly name of this organization.

Required string length: 1 - 255
branding
object

Theme defines how to style the login pages.

metadata
object

Metadata associated with the organization, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed.

token_quota
object