Skip to main content

Available Components

Setup Requirements

Before using any My Organization components, you need to configure your Auth0 tenant with the proper APIs, applications, and permissions. Follow these steps to set up your environment:
Auth0 Dashboard Configuration - Complete all steps below before using My Organization components.
1

Enable Feature Flags

Contact Auth0 support to enable the required feature flags for your tenant.
These feature flags are required and must be enabled by Auth0 support before proceeding with the setup.
2

Enable My Organization API

Go to APIs → My Organization API and make sure it’s enabled.
3

Create SPA Application

Go to Applications → Create Application:
  • Choose “Single Page Web Applications”
  • For development mode, add http://localhost:5173 to:
    • Allowed Callback URLs
    • Allowed Logout URLs
  • Set Login Experience:
    • Business users
    • Prompt for Organization (optional)
This example uses a Single Page Application, but you can also configure a Regular Web Application (RWA) following similar steps.
4

Setup Database & User

  • Create a Database connection - In Applications tab, enable your new SPA app
  • Create a user in this database (for testing purposes)
5

Setup Role

Create a role or use existing (e.g., “Organization Admin”) and add required permissions:
read:my_org:details
update:my_org:details
create:my_org:identity_providers
read:my_org:identity_providers
update:my_org:identity_providers
delete:my_org:identity_providers
update:my_org:identity_providers_detach
create:my_org:identity_providers_domains
delete:my_org:identity_providers_domains
read:my_org:domains
delete:my_org:domains
create:my_org:domains
update:my_org:domains
read:my_org:identity_providers_scim_tokens
create:my_org:identity_providers_scim_tokens
delete:my_org:identity_providers_scim_tokens
create:my_org:identity_providers_provisioning
read:my_org:identity_providers_provisioning
delete:my_org:identity_providers_provisioning
read:my_org:configuration
6

Create Organization

Go to Organizations → Create Organization:
  • In Members: Add your user and assign the role
  • In Connections: Enable your database
7

Create Client Grant

Create a client grant for the user & client pair to solve access control:
POST https://{{auth0_domain}}/api/v2/client-grants
{
  "scope": [
    "read:my_org:details",
    "update:my_org:details",
    "create:my_org:identity_providers",
    "read:my_org:identity_providers",
    "update:my_org:identity_providers",
    "delete:my_org:identity_providers",
    "update:my_org:identity_providers_detach",
    "create:my_org:identity_providers_domains",
    "delete:my_org:identity_providers_domains",
    "read:my_org:domains",
    "delete:my_org:domains",
    "create:my_org:domains",
    "update:my_org:domains",
    "read:my_org:identity_providers_scim_tokens",
    "create:my_org:identity_providers_scim_tokens",
    "delete:my_org:identity_providers_scim_tokens",
    "create:my_org:identity_providers_provisioning",
    "read:my_org:identity_providers_provisioning",
    "delete:my_org:identity_providers_provisioning",
    "read:my_org:configuration"
  ],
  "client_id": "{{auth0_client_id}}",
  "audience": "https://{{auth0_domain}}/my-organization/",
  "subject_type": "user"
}
You need a Management API token to make this request. Get one from Applications → APIs → Auth0 Management API → API Explorer.
8

Configure Environment Variables

Create a .env file in your project with your Auth0 configuration. The exact variables depend on your application type.
VITE_AUTH0_DOMAIN=your-domain.auth0.com
VITE_AUTH0_CLIENT_ID=your-spa-client-id
Environment variable configurations vary by framework and setup. Check the examples/ directory in the repository for specific implementation examples.

Quick Notes

  • User must be authenticated and member of an organization - Components automatically load organization data from current user context - All components share the same base setup requirements - See the Overview for installation and Auth0ComponentProvider configuration