Skip to content

Commit 94e5de4

Browse files
grandmaestergrandmaester
committed
feat: updates to my-org introduction
1 parent 1047761 commit 94e5de4

1 file changed

Lines changed: 39 additions & 59 deletions

File tree

‎main/docs/universal-components/my-organization/introduction.mdx‎

Lines changed: 39 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -50,20 +50,16 @@ permalink: Introduction
5050

5151
## Setup Requirements
5252

53-
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:
53+
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.
5454

5555
<Info>
5656
**Auth0 Dashboard Configuration** - Complete all steps below before using My
5757
Organization components.
5858
</Info>
5959

6060
<Steps>
61-
<Step title="Activate the API">
62-
Go to **APIs → My Organization API** and make sure it's enabled for your tenant.
63-
</Step>
64-
65-
<Step title="Create SPA Application">
66-
Go to **Applications → Create Application**:
61+
<Step title="Create Application">
62+
Go to **Dashboard → Applications → Create Application**:
6763

6864
- Choose "Single Page Web Applications"
6965
- For development mode, add `http://localhost:5173` to:
@@ -79,26 +75,44 @@ Before using any My Organization components, you need to configure your Auth0 te
7975

8076
</Step>
8177

82-
<Step title="Setup Client Configuration">
83-
In **Applications → Your App → Settings**, configure the following:
78+
<Step title="Enable the My Organization API">
79+
Navigate to **Dashboard → Applications → APIs** and select **My Organization
80+
API**. Ensure it's enabled for your tenant.
81+
</Step>
8482

85-
**Advanced Settings Section:**
86-
- **Grant Types**: Ensure "Authorization Code" and "Refresh Token" are enabled
87-
- **Token Endpoint Authentication Method**: Set to "None" for SPA (or "Client Secret Post" for Regular Web App)
83+
<Step title="Configure Application Access">
84+
While still on the My Organization API page, select the **Application Access** tab and click **Edit** for your Application.
8885

89-
<Note>
90-
These settings are required for My Organization components to function properly. The "Prompt after login" flow allows users to select which organization they want to access.
91-
</Note>
86+
Configure the following settings:
87+
- **Connection Profile** (Optional) - Select or create a profile with connection attribute mappings
88+
- **User Attribute Profile** (Optional) - Select or create a profile with user attribute mappings
89+
- **Supported Identity Providers** - Enable providers your customers can use
90+
- **Connection Deletion Behavior** - Choose **Allow** or **Allow if Empty**
91+
- **User Access Authorization** - Choose **Unauthorized**, **Authorized**, or **All**
92+
- **Client Credential Access Authorization** - Choose **Unauthorized**, **Authorized**, or **All**
93+
94+
Select **Save** to save the settings.
95+
96+
<Accordion title="Configuration Options Reference">
97+
**Connection Deletion Behavior**
98+
- **Allow**: Users can delete connections, which deletes all users from that connection.
99+
- **Allow if Empty**: Users can only delete connections with no users.
100+
101+
**User Access Authorization / Client Credential Access Authorization**
102+
- **Unauthorized**: No permissions allowed.
103+
- **Authorized**: Select specific permissions.
104+
- **All**: Include all existing and future permissions.
105+
</Accordion>
92106

93107
</Step>
94108

95109
<Step title="Setup Database & User">
96-
- Create a Database connection - In Applications tab, enable your new SPA app
97-
- Create a user in this database (for testing purposes)
110+
- Create a Database connection - In the Applications tab, enable your new SPA
111+
app - Create a user in this database (for testing purposes)
98112
</Step>
99113

100114
<Step title="Setup Role">
101-
Create a role or use existing (e.g., "Organization Admin") and add required permissions:
115+
Create a role or use an existing one (e.g., "Organization Admin") and add the required permissions from the My Organization API.
102116

103117
<Accordion title="Required Permissions">
104118
```
@@ -125,6 +139,10 @@ Before using any My Organization components, you need to configure your Auth0 te
125139
```
126140
</Accordion>
127141

142+
<Note>
143+
The user's token will only include permissions that exist in both their assigned role and the User Access Authorization settings configured in the previous step.
144+
</Note>
145+
128146
</Step>
129147

130148
<Step title="Create Organization">
@@ -135,46 +153,6 @@ Before using any My Organization components, you need to configure your Auth0 te
135153

136154
</Step>
137155

138-
<Step title="Create Client Grant">
139-
Create a client grant for the user & client pair to solve access control:
140-
141-
```json
142-
POST https://{{auth0_domain}}/api/v2/client-grants
143-
{
144-
"scope": [
145-
"read:my_org:details",
146-
"update:my_org:details",
147-
"create:my_org:identity_providers",
148-
"read:my_org:identity_providers",
149-
"update:my_org:identity_providers",
150-
"delete:my_org:identity_providers",
151-
"update:my_org:identity_providers_detach",
152-
"create:my_org:identity_providers_domains",
153-
"delete:my_org:identity_providers_domains",
154-
"read:my_org:domains",
155-
"delete:my_org:domains",
156-
"create:my_org:domains",
157-
"update:my_org:domains",
158-
"read:my_org:identity_providers_scim_tokens",
159-
"create:my_org:identity_providers_scim_tokens",
160-
"delete:my_org:identity_providers_scim_tokens",
161-
"create:my_org:identity_providers_provisioning",
162-
"read:my_org:identity_providers_provisioning",
163-
"delete:my_org:identity_providers_provisioning",
164-
"read:my_org:configuration"
165-
],
166-
"client_id": "{{auth0_client_id}}",
167-
"audience": "https://{{auth0_domain}}/my-organization/",
168-
"subject_type": "user"
169-
}
170-
```
171-
172-
<Note>
173-
You need a Management API token to make this request. Get one from **Applications → APIs → Auth0 Management API → API Explorer**.
174-
</Note>
175-
176-
</Step>
177-
178156
<Step title="Configure Environment Variables">
179157
Create a `.env` file in your project with your Auth0 configuration. The exact variables depend on your application type.
180158

@@ -200,7 +178,9 @@ Before using any My Organization components, you need to configure your Auth0 te
200178
</Steps>
201179

202180
<Info>
203-
You are responsible for ensuring that your use of the My Organization API and Embeddable UI Components comply with your security policies and applicable laws, including any permissions granted to your end users.
181+
You are responsible for ensuring that your use of the My Organization API and
182+
Embeddable UI Components comply with your security policies and applicable
183+
laws, including any permissions granted to your end users.
204184
</Info>
205185

206186
## Quick Notes

0 commit comments

Comments
 (0)