You are here:
Create Credentials for Your Intelligent Document Reader AWS Account
To authenticate the Amazon Web Services (AWS) account that you’re using for Intelligent Document Reader, create an external credential. Then create a named credential for the external credential.
Required Editions
| Available in: Lightning Experience |
| Available in: Automotive Cloud, Consumer Goods Cloud, Education Cloud, Financial Services Cloud, Health Cloud, Manufacturing Cloud, Media Cloud, Net Zero Cloud, Nonprofit Cloud, Public Sector Solutions. View product and edition availability. |
| Intelligent Document Reader is available with the Intelligent Document Reader add-on license. |
Note A named credential stores your AWS account information. You can create a named credential
in Setup. To extract key and value pairs from documents using Intelligent Document Reader, you
must first get values such as access keys, account ID, ARN, and IAM role from your AWS account.
Use these AWS values to create an external credential and named credential. Additionally, create
and assign a permission set to users.
- Log in to your Salesforce org as an administrator, and then assign the Document Checklist and Intelligent Document Workspace User permission sets to the admin user.
-
Update Salesforce file settings.
- From Setup, in the Quick Find box, enter Salesforce Files, and then select General Settings.
- Click Edit, and then select Display alternative file previews.
- Save your changes.
-
Create a document type.
- From Setup, in the Quick Find box, enter Document Type, and then select Document Type.
- Click New.
- Specify the label, name, and form type.
- Save your changes.
-
Create an external credential for AWS.
- From Setup, in the Quick Find box, enter Named Credentials, and then select Named Credentials.
- On the External Credential tab, select New.
- Specify these details and save your changes. Configure STS for Temporary Access, if necessary.
Field Description Label A user-friendly name for the named credential that’s shown in the Salesforce user interface. Name A unique identifier for this external credential. Authentication Protocol Select AWS Signature Version 4. Service The name of an AWS service, such as textract. Region The AWS region for the named credential’s endpoint. For example, us-west-2. AWS Account ID The 12-digit number that uniquely identifies your AWS account. Use STS for Temporary Access To provide limited access, select the checkbox, and then specify the STS access key, access secret, external ID, and duration. See Create and Edit an AWS Signature v4 External Credential. Salesforce recommends using External Named Credentials followed by Named Credential for the AWS setup in Intelligent Document Reader (IDR). However, you can also opt to use Legacy Named Credential to configure AWS with IDR. For more information, see https://help.salesforce.com/s/articleView?id=xcloud.named_credentials_define.htm&type=5&language=en_US
-
Configure the principal for the external credential.
- Open the external credential that you created.
- In the Principals section, click New.
- Specify the parameter name, access key, access secret, and ARN.
- Save your changes.
You can’t modify the principal name of an existing principal. To change these parameters, delete the principal and recreate it. -
Create a Named Credential by using the external credential.
- From Setup, in the Quick Find box, enter Named Credentials, and then select Named Credentials.
- Click New.
-
Specify the label, name, and URL, and select the previously created external credential.
The format for the URL is https://www.aws.com. See Create and Edit a Named Credential.
- Save your changes.
When creating a named credential, make sure that you specify an Amazon Textract endpoint as the URL. See Amazon Textract endpoints and quotas - AWS General Reference. -
Create a permission set and provide access to the external credential.
- From Setup, in the Quick Find box, enter Permission sets, and then select Permission sets.
- Click New.
- Specify the label and name.
- Save your changes.
-
In the Apps section, click External Credential Principal Access,
and click Edit.
Permission sets with external credential principal access enabled can be packaged.
-
Click Edit.
The Edit page shows the available external credential principals, and the external credential principals that are currently enabled.
- Select one or more external credential principals.
- Save your changes.
-
Assign the new permission set to the admin user.
- Select the permission set.
- Click Manage Assignments, and then select Add Assignments.
- Select the user that you want to assign the permission set to, and click Next.
- Click Assign.
-
Assign the permission set to the Autoproc user by using this Apex code in Workbench.
insert new PermissionSetAssignment( AssigneeId = [SELECT Id FROM User WHERE alias = 'autoproc'].Id, PermissionSetId = 'SELECT PermissionSet Id' );
Note In Workbench, query the PermissionSet object to retrieve the ID and label. Copy the specific permission set ID and replace the 'SELECT PermissionSet Id' text in the executed text box with the copied ID before you run the code.
Did this article solve your issue?
Let us know so we can improve!

