Skip to content

Commit 592bf87

Browse files
kushalshit27kushalshit27
authored
feat: add directory provisioning support for connections (#1246)
* feat: add directory provisioning support for connections - src/tools/auth0/handlers/connections.ts: add directory_provisioning_configuration to schema - src/tools/auth0/handlers/connections.ts: implement methods for retrieving, creating, updating, and deleting directory provisioning configurations - src/tools/auth0/handlers/connections.ts: process directory provisioning in connection changes * feat: enhance error handling in connections handler - src/tools/auth0/handlers/connections.ts: throw ManagementError instead of generic Error for better error classification - src/tools/auth0/handlers/connections.ts: improve logging for directory provisioning fetch errors * feat: update error messages and clean up bodyParams for directory provisioning - src/tools/auth0/handlers/connections.ts: change error messages to use connection ID instead of name - src/tools/auth0/handlers/scimHandler.ts: remove directory_provisioning_configuration from bodyParams * feat: add Google Workspace directory provisioning support - docs/resource-specific-documentation.md: document directory provisioning for Google Workspace connections - examples/directory/connections/google-apps.json: add example configuration for Google Workspace directory provisioning - examples/yaml/tenant.yaml: include Google Workspace connection in tenant YAML configuration - src/tools/auth0/handlers/connections.ts: implement directory provisioning create, update, and delete operations - test/tools/auth0/handlers/connections.tests.js: add tests for directory provisioning configuration handling - test/tools/auth0/handlers/scimHandler.tests.js: ensure directory provisioning configuration is removed before updating connection * feat: enhance directory provisioning handling and tests - src/tools/auth0/handlers/connections.ts: improve error handling for directory provisioning and add debug logs for create, update, and delete operations - test/tools/auth0/handlers/connections.tests.js: update test to use sinon.match for more flexible assertions * feat: update SCIM handler to remove unnecessary configuration - src/tools/auth0/handlers/scimHandler.ts: delete from bodyParams * feat: update directory provisioning configuration - docs/resource-specific-documentation.md: set synchronize_automatically to false - examples/directory/connections/google-apps.json: set synchronize_automatically to false - examples/yaml/tenant.yaml: set synchronize_automatically to false - examples/yaml/tenant.yaml: add api_enable_users field - examples/directory/connections/google-apps.json: add api_enable_users field - docs/resource-specific-documentation.md: add api_enable_users field
1 parent 9062d24 commit 592bf87

7 files changed

Lines changed: 567 additions & 4 deletions

File tree

‎docs/resource-specific-documentation.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,61 @@ Contents of `promptName_screenName.json`
121121
}
122122
```
123123

124+
## Connections (Google Workspace directory provisioning)
125+
126+
The Deploy CLI supports managing the `directory_provisioning_configuration` for Google Workspace (`google-apps`) connections. Only `google-apps` connections are processed for directory provisioning; other strategies will ignore this block. Deleting directory provisioning requires `AUTH0_ALLOW_DELETE=true`.
127+
128+
The `mapping` array pairs Auth0 user fields with IdP fields, and `synchronize_automatically` controls whether Auth0 runs scheduled sync jobs for the connection.
129+
130+
**YAML Example**
131+
132+
```yaml
133+
connections:
134+
- name: google-workspace
135+
strategy: google-apps
136+
options:
137+
domain: example.com
138+
tenant_domain: example.com
139+
client_id: 'some_client_id'
140+
client_secret: 'some_client_secret'
141+
api_enable_users: true
142+
directory_provisioning_configuration:
143+
mapping:
144+
- auth0: email
145+
idp: mail
146+
- auth0: name
147+
idp: displayName
148+
synchronize_automatically: false
149+
```
150+
151+
**Directory Example**
152+
153+
```
154+
./connections/google-apps-directory-provisioning.json
155+
```
156+
157+
```json
158+
{
159+
"name": "google-apps-directory-provisioning",
160+
"strategy": "google-apps",
161+
"enabled_clients": ["My SPA"],
162+
"options": {
163+
"domain": "example.com",
164+
"tenant_domain": "example.com",
165+
"client_id": "some_client_id",
166+
"client_secret": "some_client_secret",
167+
"api_enable_users": true
168+
},
169+
"directory_provisioning_configuration": {
170+
"mapping": [
171+
{ "auth0": "email", "idp": "mail" },
172+
{ "auth0": "name", "idp": "displayName" }
173+
],
174+
"synchronize_automatically": false
175+
}
176+
}
177+
```
178+
124179
## Databases
125180

126181
When managing database connections, the values of `options.customScripts` point to specific javascript files relative to

‎examples/directory/connections/google-apps.json‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"name": "google-apps-directory-provisioning",
3+
"strategy": "google-apps",
4+
"enabled_clients": [
5+
"My SPA"
6+
],
7+
"options": {
8+
"domain": "example.com",
9+
"tenant_domain": "example.com",
10+
"client_id": "some_client_id",
11+
"client_secret": "some_client_secret",
12+
"api_enable_users": true
13+
},
14+
"directory_provisioning_configuration": {
15+
"mapping": [
16+
{ "auth0": "email", "idp": "mail" },
17+
{ "auth0": "name", "idp": "displayName" }
18+
],
19+
"synchronize_automatically": false
20+
}
21+
}

‎examples/yaml/tenant.yaml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,24 @@ connections:
111111
ext_groups: true
112112
# Add other connection settings (https://auth0.com/docs/api/management/v2#!/Connections/post_connections)
113113

114+
- name: "google-workspace"
115+
strategy: "google-apps"
116+
enabled_clients:
117+
- "My SPA"
118+
options:
119+
domain: "example.com"
120+
tenant_domain: "example.com"
121+
client_id: 'some_client_id'
122+
client_secret: 'some_client_secret'
123+
api_enable_users: true
124+
directory_provisioning_configuration:
125+
mapping:
126+
- auth0: "email"
127+
idp: "mail"
128+
- auth0: "name"
129+
idp: "displayName"
130+
synchronize_automatically: false
131+
114132

115133
resourceServers:
116134
-

0 commit comments

Comments
 (0)