Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions docs/resource-specific-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,61 @@ Contents of `promptName_screenName.json`
}
```

## Connections (Google Workspace directory provisioning)

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`.

The `mapping` array pairs Auth0 user fields with IdP fields, and `synchronize_automatically` controls whether Auth0 runs scheduled sync jobs for the connection.

**YAML Example**

```yaml
connections:
- name: google-workspace
strategy: google-apps
options:
domain: example.com
tenant_domain: example.com
client_id: 'some_client_id'
client_secret: 'some_client_secret'
api_enable_users: true
directory_provisioning_configuration:
mapping:
- auth0: email
idp: mail
- auth0: name
idp: displayName
synchronize_automatically: false
```

**Directory Example**

```
./connections/google-apps-directory-provisioning.json
```

```json
{
"name": "google-apps-directory-provisioning",
"strategy": "google-apps",
"enabled_clients": ["My SPA"],
"options": {
"domain": "example.com",
"tenant_domain": "example.com",
"client_id": "some_client_id",
"client_secret": "some_client_secret",
"api_enable_users": true
},
"directory_provisioning_configuration": {
"mapping": [
{ "auth0": "email", "idp": "mail" },
{ "auth0": "name", "idp": "displayName" }
],
"synchronize_automatically": false
}
}
```

## Databases

When managing database connections, the values of `options.customScripts` point to specific javascript files relative to
Expand Down
21 changes: 21 additions & 0 deletions examples/directory/connections/google-apps.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"name": "google-apps-directory-provisioning",
"strategy": "google-apps",
"enabled_clients": [
"My SPA"
],
"options": {
"domain": "example.com",
"tenant_domain": "example.com",
"client_id": "some_client_id",
"client_secret": "some_client_secret",
"api_enable_users": true
},
"directory_provisioning_configuration": {
"mapping": [
{ "auth0": "email", "idp": "mail" },
{ "auth0": "name", "idp": "displayName" }
],
"synchronize_automatically": false
}
}
18 changes: 18 additions & 0 deletions examples/yaml/tenant.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,24 @@ connections:
ext_groups: true
# Add other connection settings (https://auth0.com/docs/api/management/v2#!/Connections/post_connections)

- name: "google-workspace"
strategy: "google-apps"
enabled_clients:
- "My SPA"
options:
domain: "example.com"
tenant_domain: "example.com"
client_id: 'some_client_id'
client_secret: 'some_client_secret'
api_enable_users: true
directory_provisioning_configuration:
mapping:
- auth0: "email"
idp: "mail"
- auth0: "name"
idp: "displayName"
synchronize_automatically: false


resourceServers:
-
Expand Down
Loading