How to create an API user

In some scenario's you may need to create an API user for Byner. For example when connecting a third party app to Byner. 

In this article:

• Step 1: Create a Permission Set
• Step 2: Add permissions to the Permission set
• Step 3: Create User

• Step 4: Activate User

   

Step 1: Create a Permission Set

Before we create the API user we have to create the right Permission Set for this user.

1. From Salesforce Setup, use the Quick Find box to find Permission Sets.
2. Click New.
   1. We suggest the following naming convention:
      1. Label: <App name> - Integration User Permissions
      2. API Name: <App name>_Integration_User_Permissions
3. Leave other fields as is and click Save.

Step 2: Add permissions to the Permission set

Each integration requires different permissions. Ensure you only set the required permissions for security reasons. 

Example

1. Open the Permission Set
2. Scroll down and click System Permissions.
3. Click Edit and select the following permissions:
   • API enabled (almost always required in integration scenarios)
   • Password Never Expires (almost always required in integration scenarios)
4. Click Save.

Please refer to the specific integration documentation to see what permissions need to be granted.

Step 3: Create User

Now it's time to create a user. Make sure there is a license available for this user.

1. In case User Management is activated for the org:
   1. Create a Permission set group via Salesforce Setup, and put the Permission set you've created for this API user in this Permission set group.
   2. Navigate to the Byner Permission Set Groups field on the User object (Salesforce Setup > Object manager > User > Fields & Relationships). Add the API name of the Permission set group in the picklist value set.
   3. Go back to Fields & Relationships, choose 'Field dependencies' and edit the dependency where the Byner Permission Set Groups field is the dependent field. Include the just added picklist value for the Byner - API profile and save.
   4. Navigate to Byner Setup > User management. Create a new user:
      1. Set the First Name to something meaningful, like '<app name>'.
      2. Set the Last Name to something meaninful, like 'API'.
      3. Use a valid email address, you'll need access to this email address.
      4. Use a meaningful username like '<appname>@byner.<yourorgname>'.
      5. Activate the Send welcome email checkbox.
      6. Choose Byner - API as profile, and select the just created Permission set group.
      7. Save.
2. In case User Management is not activated for the org: 
   From Salesforce Setup, use the Quick Find box to find Users.
   1. Click New User.
      • Set the First Name to something meaningful, like '<app name>'.
      • Set the Last Name to something meaninful, like 'API'.
      • Use a valid email address, you'll need access to this email address.
      • Use a meaningful username like '<appname>@byner.<yourorgname>'.
      • Pick Salesforce Platform as User License.
      • Select a Profile.
        Do NOT grant acces via profiles. When your Salesforce org is set up correctly, access is  only granted through Permission Sets and Permission Set Groups.
      • Set the correct Language.
   2. Click Save.
      • Optionally you can enter more information, but this is not required.

Step 4: Activate User

Before you active the API user make sure you have assigned the all required Permission Sets (preferably via a Permission Set Group) and grant the user a Byner Package License when access to Byner is required. (This is automatically done when the user has been created via Byner User Management.

1. Go to your mailbox and open the Byner Login Information email.
2. Open the URL to set your password.
   • When working with multiple Salesforce Orgs we advise to open this URL in an incognito window in your browser.
3. Set your password and secret question.
   • We advise to save your credentials to a password manager like LastPass.
   • Don't forget to remember or save your secret question aswell.
4. Set op MFA
5. Set up a security token.
   • You should also save this to your password manager.

Security token explained

When you access Salesforce from an IP address that’s outside your company’s trusted IP range using a desktop client or the API, you need a security token to log in. A security token is a case-sensitive alphanumeric code that you append to your password or entered in a separate field in a client application.

Your security token isn’t displayed in your settings or profile.

1. From your personal settings, in the Quick Find box, enter Reset, and then select Reset My Security Token. Click Reset Security Token.
2. The new security token is sent to the email address in your Salesforce personal settings.

You also receive a new security token email when you reset your password.

Congratulations

You have now set up an API user. Continue to open up access to Byner (Salesforce) by creating an External client credentials app.