AWS bedrock: Salesforce KB connector: document-level ACL and JWT Bearer auth docs
Summary
Adds documentation for enabling document-level access control (ACLs) on the Salesforce managed data source, including the new OAuth 2.0 with JWT Bearer Token authentication method, the aclEnabled connector parameter, updated console steps, and revised secret/authType field descriptions. Replaces the prior note that Salesforce does not support document-level access control.
Security assessment
The change documents an authorization capability: enabling ACLs so query results are filtered by user permissions, requiring OAUTH2_WITH_JWT_BEARER and the aclEnabled parameter. It also removes the prior statement that all authenticated users can see all crawled content, reducing risk of over-exposure. No specific vulnerability, CVE, or incident is referenced, so it is security documentation rather than a fix.
Evidence
+ 7. Under **Access control list** , for **Crawl Access Control Lists (ACLs)** , choose **Enable** to enable document-level access control, or **Disable**. Enabling ACLs requires OAuth 2.0 with JWT Bearer Token authentication, and you can't change this setting after you create the data source. For details, see [Document-level access controls](./kb-managed-ds-salesforce-acl.html).
Diff
diff --git a/bedrock/latest/userguide/kb-managed-ds-salesforce-connect.md b/bedrock/latest/userguide/kb-managed-ds-salesforce-connect.md index 367b669..af43507 100644 --- a//bedrock/latest/userguide/kb-managed-ds-salesforce-connect.md +++ b//bedrock/latest/userguide/kb-managed-ds-salesforce-connect.md @@ -15 +15 @@ After you set up authentication and store your credentials in an AWS Secrets Man -Complete authentication setup first. See [Set up OAuth 2.0 Client Credentials authentication for Salesforce](./kb-managed-salesforce-oauth2-setup.html). You need the secret ARN. +Complete authentication setup first. See [Set up OAuth 2.0 Client Credentials authentication for Salesforce](./kb-managed-salesforce-oauth2-setup.html). To use document-level access control, also complete [Set up OAuth 2.0 JWT Bearer authentication for Salesforce document-level access controls](./kb-managed-salesforce-jwt-bearer-setup.html). You need the secret ARN. @@ -32 +32 @@ Console - 5. Under **Authentication** , the connector uses OAuth 2.0. Select or create an AWS Secrets Manager secret containing your `clientId`, `clientSecret`, and `instanceUrl`. + 5. Under **Authentication** , for **Authentication method** , choose one of the following: @@ -34 +34,9 @@ Console - 6. Under **Sync scope** , select the content to crawl: + * **OAuth 2.0 with JWT Bearer Token** – Required for document-level access control. For setup, see [Set up OAuth 2.0 JWT Bearer authentication for Salesforce document-level access controls](./kb-managed-salesforce-jwt-bearer-setup.html). + + * **OAuth 2.0** – Crawls content with your External Client App credentials. Access control lists (ACLs) aren't applied. This option is available only when ACLs are disabled. + + 6. For **AWS Secrets Manager secret** , select an AWS Secrets Manager secret. For OAuth 2.0, the secret contains your `clientId`, `clientSecret`, and `instanceUrl`. For OAuth 2.0 with JWT Bearer Token, the secret contains the six fields described in [Step 5: Create the Secrets Manager secret](./kb-managed-salesforce-jwt-bearer-setup.html#kb-managed-salesforce-jwt-bearer-step5). + + 7. Under **Access control list** , for **Crawl Access Control Lists (ACLs)** , choose **Enable** to enable document-level access control, or **Disable**. Enabling ACLs requires OAuth 2.0 with JWT Bearer Token authentication, and you can't change this setting after you create the data source. For details, see [Document-level access controls](./kb-managed-ds-salesforce-acl.html). + + 8. Under **Sync scope** , select the content to crawl: @@ -42 +50 @@ Console - 7. (Optional) Under **Data categories inclusion filter** , specify a category group name and category names to limit synced articles. All data categories sync by default. For **Category depth** , choose how articles are synced relative to the specified category: **At** , **Above** , **Below** , or **Above, Below**. Choose **Add categories** to add more category groups. + 9. (Optional) Under **Data categories inclusion filter** , specify a category group name and category names to limit synced articles. All data categories sync by default. For **Category depth** , choose how articles are synced relative to the specified category: **At** , **Above** , **Below** , or **Above, Below**. Choose **Add categories** to add more category groups. @@ -44 +52 @@ Console - 8. (Optional) Under **Documents filter by folders** , enter folder IDs to sync documents from specific folders only. All documents sync by default. + 10. (Optional) Under **Documents filter by folders** , enter folder IDs to sync documents from specific folders only. All documents sync by default. @@ -52 +60 @@ API -To create a Salesforce data source, send a [CreateDataSource](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateDataSource.html) request with an Agents for Amazon Bedrock build-time endpoint. The following AWS Command Line Interface example creates a Salesforce data source. For a description of each field, see the connector parameters reference that follows. +To create a Salesforce data source, send a [CreateDataSource](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateDataSource.html) request with an Agents for Amazon Bedrock build-time endpoint. The following AWS Command Line Interface example creates a Salesforce data source. To enable document-level access control, set `aclEnabled` to `true` and `authType` to `OAUTH2_WITH_JWT_BEARER`; for an example, see [Document-level access controls](./kb-managed-ds-salesforce-acl.html). For a description of each field, see the connector parameters reference that follows. @@ -112 +120 @@ connectionConfiguration Field | Required | Description -`secretArn` | Yes | The ARN of the AWS Secrets Manager secret containing your `clientId`, `clientSecret`, and `instanceUrl`. +`secretArn` | Yes | The ARN of the AWS Secrets Manager secret containing your `clientId`, `clientSecret`, and `instanceUrl`. For `OAUTH2_WITH_JWT_BEARER`, the secret also contains `consumerKey`, `privateKey`, and `instanceType`. See [Step 5: Create the Secrets Manager secret](./kb-managed-salesforce-jwt-bearer-setup.html#kb-managed-salesforce-jwt-bearer-step5). @@ -114 +122,7 @@ connectionConfiguration Field | Required | Description -`authType` | Yes | The authentication type. Salesforce supports `OAUTH2`. See [Authentication method](./kb-managed-ds-salesforce.html#kb-managed-salesforce-auth-methods). +`authType` | Yes | The authentication type: `OAUTH2` or `OAUTH2_WITH_JWT_BEARER`. The `OAUTH2_WITH_JWT_BEARER` type is available only when `aclEnabled` is `true`. See [Authentication methods](./kb-managed-ds-salesforce.html#kb-managed-salesforce-auth-methods). + +The following table describes the optional `aclEnabled` field. + +aclEnabled (optional) Field | Required | Description +---|---|--- +`aclEnabled` | No | Set to `true` to enable document-level access control. Requires `OAUTH2_WITH_JWT_BEARER` authentication. You cannot change this setting after you create the data source. For details, see [Document-level access controls](./kb-managed-ds-salesforce-acl.html). @@ -148 +162 @@ The `operator` field in `dataCategoryConfiguration` sets the category depth – -After you create the data source, sync it to ingest content into your knowledge base. For details, see [Sync a data source](./kb-managed-sync.html). Because Salesforce doesn't support document-level access control, all authenticated users who can query the knowledge base can see all crawled content. +After you create the data source, sync it to ingest content into your knowledge base. For details, see [Sync a data source](./kb-managed-sync.html). To filter query results by user permissions, see [Document-level access controls](./kb-managed-ds-salesforce-acl.html). @@ -156 +170 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Set up Client Credentials authentication +Set up JWT Bearer authentication @@ -158 +172 @@ Set up Client Credentials authentication -ServiceNow +Document-level access controls