Skip to main content
The OrganizationDetailsEdit component provides a unified interface to edit your organization details.

Third-party application access

third_party_client_access is an organization-level setting that controls whether third-party applications can authenticate users through the organization’s SSO providers. Its values are "allow" and "block", defaulting to "block". The component reads GET /my-org/config to determine which values the tenant permits. When third_party_client_access.allowed_values contains only "block", the radio group is shown but is read-only — the organization administrator cannot change it. When both values are permitted, the field is editable and saves to the organization details resource. This setting acts as an organization-wide gate. It does not configure Cross App Access (XAA), which is a separate authorization path controlled at the SSO provider level.

Setup requirements

Auth0 Configuration Required—Ensure your tenant is configured with the My Organization API. View setup guide →

Installation

Running either command also installs the @auth0/universal-components-core dependency for shared utilities and Auth0 integration.

Get started

Props

Required props

Required props are fundamental to the component’s operation. OrganizationDetailsEdit has no required props—it automatically loads the current organization’s details from the My Organization API.

Display props

Display props control how the component renders without affecting its behavior. Use these to hide sections or enable read-only mode.
PropTypeDescription
readOnlybooleanDisable all form inputs. Default: false
hideHeaderbooleanHide the header section. Default: false

Action props

Action props handle user interactions and define what happens when users save or cancel changes. Use lifecycle hooks (onBefore, onAfter) to integrate with your application’s routing and analytics.
PropTypeDescription
saveActionComponentAction<OrganizationPrivate>Save changes action.
cancelActionComponentAction<OrganizationPrivate>Cancel/discard changes action.
backButtonObjectBack button configuration.
saveActionType: ComponentAction<OrganizationPrivate>Controls the save flow when users submit organization changes. Use onAfter to navigate away after successful save.Properties:
  • disabled—Disable the save button (for example, while another operation is in progress)
  • onBefore(data)—Runs before the save operation. Return false to prevent saving (for example, to show a confirmation dialog first).
  • onAfter(data)—Runs after the organization is successfully saved. Use this to navigate away or track the event.
Example:

cancelActionType: ComponentAction<OrganizationPrivate>Controls the cancel/discard flow. Use this action to manage discarded changes.Properties:
  • disabled—Disable the cancel button
  • onAfter(data)—Runs after the cancel is confirmed. Use this to navigate away from the form.
Example:

backButtonType: { icon?: LucideIcon; onClick: (e: MouseEvent) => void }Configures the back button in the component header. Use this to navigate back to your organization overview or the previous page.Properties:
  • icon—Custom Lucide icon component (optional, defaults to ArrowLeft)
  • onClick—Click handler for navigation
Example:

Customization props

Customization props let you adapt the component to your brand, locale, and validation requirements without modifying source code.
PropTypeDescription
schemaOrganizationDetailsEditSchemasField validation rules.
customMessagesPartial<OrganizationDetailsEditMessages>i18n text overrides.
stylingComponentStyling<OrganizationEditClasses>CSS variables and class overrides.
schemaSet custom validation rules for organization detail fields.
All schema fields support: regex, errorMessage, minLength, maxLength, requireddetails.name—Organization internal name details.displayName—Organization display name details.primaryColor—Primary brand color (hex format) details.backgroundColor—Page background color (hex format) details.logoURL—Logo URL

customMessagesCustomize all text and translations. All fields are optional and use defaults if not provided.
header—Component header
  • title, back_button_text
details.sections.settings—Settings section
  • title
  • fields.namelabel, placeholder, helper_text, error
  • fields.display_namelabel, placeholder, helper_text, error
  • fields.third_party_client_accesslabel, options.block.label, options.block.helper_text, options.allow.label, options.allow.helper_text
details.sections.branding—Branding section
  • title
  • fields.logolabel, helper_text, error
  • fields.primary_colorlabel, helper_text, error
  • fields.page_background_colorlabel, helper_text, error
details—Form labels
  • unsaved_changes_text, submit_button_label, cancel_button_label
notifications—API responses
  • save_organization_changes_message, organization_changes_error_message, organization_changes_error_message_generic

stylingCustomize appearance with CSS variables and class overrides. Supports theme-aware styling.
Variables—CSS custom properties
  • common—Applied to all themes
  • light—Light theme only
  • dark—Dark theme only
Classes—Component class overrides
  • OrganizationDetails_Card
  • OrganizationDetails_FormActions
  • OrganizationDetails_SettingsDetails
  • OrganizationDetails_BrandingDetails
  • OrganizationDetails_ThirdPartyAccess

Advanced customization

Available hooks

These hooks provide the underlying logic without any UI. Use them to build completely custom interfaces while leveraging the Auth0 API integration.
HookDescription
useOrganizationDetailsEditOrganization editing logic and API integration