Skip to content

Commit

Permalink
Update docs for support exclusions of individual resource (#944)
Browse files Browse the repository at this point in the history 
* Document update:
The by Name method of exclusion is supported for:
`AUTH0_EXCLUDED_RULES` ,
`AUTH0_EXCLUDED_CLIENTS`,
`AUTH0_EXCLUDED_DATABASES`,
`AUTH0_EXCLUDED_CONNECTIONS`,
`AUTH0_EXCLUDED_RESOURCE_SERVERS`
  • Loading branch information
@kushalshit27
kushalshit27 authored Aug 27, 2024
1 parent 88a7c49 commit 4b062cf
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
10 changes: 5 additions & 5 deletions docs/configuring-the-deploy-cli.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -149,23 +149,23 @@ String. Separate value from audience value while retrieving an access token for

### `AUTH0_EXCLUDED_RULES`

Array of strings. Excludes the management of specific rules by ID. **Note:** This configuration may be subject to deprecation in the future. See: [excluding resources from management](excluding-from-management.md).
Array of strings. Excludes the management of specific rules by name. **Note:** This configuration may be subject to deprecation in the future. See: [excluding resources from management](excluding-from-management.md).

### `AUTH0_EXCLUDED_CLIENTS`

Array of strings. Excludes the management of specific clients by ID. **Note:** This configuration may be subject to deprecation in the future. See: [excluding resources from management](excluding-from-management.md).
Array of strings. Excludes the management of specific clients by name. **Note:** This configuration may be subject to deprecation in the future. See: [excluding resources from management](excluding-from-management.md).

### `AUTH0_EXCLUDED_DATABASES`

Array of strings. Excludes the management of specific databases by ID. **Note:** This configuration may be subject to deprecation in the future. See: [excluding resources from management](excluding-from-management.md).
Array of strings. Excludes the management of specific databases by name. **Note:** This configuration may be subject to deprecation in the future. See: [excluding resources from management](excluding-from-management.md).

### `AUTH0_EXCLUDED_CONNECTIONS`

Array of strings. Excludes the management of specific connections by ID. **Note:** This configuration may be subject to deprecation in the future. See: [excluding resources from management](excluding-from-management.md).
Array of strings. Excludes the management of specific connections by name. **Note:** This configuration may be subject to deprecation in the future. See: [excluding resources from management](excluding-from-management.md).

### `AUTH0_EXCLUDED_RESOURCE_SERVERS`

Array of strings. Excludes the management of specific resource servers by ID. **Note:** This configuration may be subject to deprecation in the future. See: [excluding resources from management](excluding-from-management.md).
Array of strings. Excludes the management of specific resource servers by name. **Note:** This configuration may be subject to deprecation in the future. See: [excluding resources from management](excluding-from-management.md).

---

Expand Down
6 changes: 3 additions & 3 deletions docs/excluding-from-management.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@ The following example dictates to _only_ manage `actions`, `clients` and `connec

## Excluding single resources by ID

Some resource types support exclusions of individual resource by ID. This is primarily useful if you work in a multi-environment context and wish to omit a production single, specific resource from your lower-level environments. The by-ID method of exclusion is supported for rules, clients, databases, connections and resource servers with the `AUTH0_EXCLUDED_RULES` ,`AUTH0_EXCLUDED_CLIENTS`, `AUTH0_EXCLUDED_DATABASES`, `AUTH0_EXCLUDED_CONNECTIONS`, `AUTH0_EXCLUDED_RESOURCE_SERVERS` configuration values respectively.
Some resource types support exclusions of individual resource by name. This is primarily useful if you work in a multi-environment context and wish to omit a production single, specific resource from your lower-level environments. The by-Name method of exclusion is supported for rules, clients, databases, connections and resource servers with the `AUTH0_EXCLUDED_RULES` ,`AUTH0_EXCLUDED_CLIENTS`, `AUTH0_EXCLUDED_DATABASES`, `AUTH0_EXCLUDED_CONNECTIONS`, `AUTH0_EXCLUDED_RESOURCE_SERVERS` configuration values respectively.

```json
{
"AUTH0_DOMAIN": "example-site.us.auth0.com",
"AUTH0_CLIENT_ID": "<YOUR_AUTH0_CLIENT_ID>",
"AUTH0_EXCLUDED_CLIENTS": ["PdmQpGy72sHksV6ueVNZVrV4GDlDDm76"],
"AUTH0_EXCLUDED_CONNECTIONS": ["con_O1H3KyRMFP1IWRq3", "con_9avEYuj19ihqKBOs"]
"AUTH0_EXCLUDED_CLIENTS": ["Your Application Name"],
"AUTH0_EXCLUDED_CONNECTIONS": ["Your Connection Name"]
}
```

Expand Down

0 comments on commit 4b062cf

Please sign in to comment.