Skip to main content
Version: 3.9

Basic Auth Accounts in R-COM Gateway

Basic Auth accounts provide secure, limited access to REST API endpoints in R-COM Gateway for third-party systems without requiring access to the administration interface. This feature suits integrations, automation scripts, or vendor connections that need access to specific endpoints only.

When you create an endpoint and select Basic authentication, only mapped Basic Auth accounts can access it with a username and password.

When configuring a Basic Auth account, select which endpoints it can access. The integration then uses the account's username and password for those endpoints.

Where to Begin​

From the R-COM Gateway dashboard, go to:

  1. Administration > User Access > Basic Auth

  2. This page displays the configured Basic Auth accounts and their status.

  3. Select Create Basic Auth.

Manage external users

Manage external users

Create a Basic Auth Account​

On the Create Basic Auth page, configure the account details and endpoint access.

1. Enter Basic Information​

Fill in the following fields:

Manage external users

Add basic external users configuration

FieldDescription
First NameThe user's given name. Used for identification and audit logs.
Last NameThe user's surname. Helps distinguish users with similar usernames.
UsernameUnique identifier used for login. Only alphanumeric characters and _ are allowed.
PasswordSecure credential used for Basic Authentication.
info

The username and password combination is used in API calls for authentication.

2. Assign Endpoint Access​

Define which REST API endpoints the Basic Auth account can access. You can assign multiple endpoints.

Add API access for external users

Add API access for external users

FieldDescription
EndpointsSelect one or more existing API endpoints to which this account should have access.
Account activeEnables or disables the account.
info

Basic Auth accounts can only call the endpoints explicitly assigned here. Make sure these endpoints are properly configured under Integrations > REST API.

The endpoint's Authentication must be set to Basic Auth; otherwise it will not appear in the dropdown.

An endpoint configured for Basic Auth can only be accessed with the username and password of a mapped Basic Auth account.

REST API Endpoint Configuration in R-COM Gateway

3. Save and Confirm​

Select Save to create the Basic Auth account.

The account appears in the Basic Auth list. The table shows First Name, Last Name, Username, Endpoints, Account Status, and Actions. At any point, you can:

  • Edit the user's credentials or endpoint permissions
  • Delete the user to revoke access immediately
  • Disable the account temporarily

API Authentication Format​

Basic Auth accounts authenticate using HTTP Basic Authentication. Use the following format for API requests:

Header:

Authorization: Basic <base64(username:password)>

Example using curl:

curl -X POST https://rcom-gateway.example.com/api/inventory/scan 
  -H "Authorization: Basic d2FyZWhvdXNlcl9hcGk6U2VjdXJlUGFzcw==" \
  -H "Content-Type: application/json" \
  -d '{ "itemId": "12345", "location": "Dock A" }'

JavaScript:

fetch('https://example.com/api/endpoint', {
    method: 'GET', // or POST, PUT, etc.
    headers: {
        'Authorization': `Basic d2FyZWhvdXNlcl9hcGk6U2VjdXJlUGFzcw==`,
        'Content-Type': 'application/json' // optional, based on your API
    }
})
tip

Use your username and password with the provided API to generate your base64 encoded authentication key. Ensure that you do not share this key with anyone.

Method: POST
URL: https://159.69.47.169/RCOMENDPOINTAPI/token

Headers:

Content-Type: application/json

Body (choose raw → JSON):

{
  "userName": "<username>",
  "password": "<password>"
}

Managing Basic Auth Accounts​

To view or modify access:

  • Navigate back to Administration > User Access > Basic Auth.

  • Use the edit or delete icons beside any entry

warning

Security Reminder: Always revoke credentials for integrations no longer in use. Do not reuse usernames across systems.

Example Use Case​

A logistics vendor must push pallet data into your R-COM Gateway system via API. You can:

  • Create a Basic Auth account named vendor_pallets.
  • Assign access to the route /api/pallets/receive
  • Share credentials securely with the vendor's system

The vendor can now push data automatically without full platform access.

tip

>> When and Why to Use Basic Auth Accounts Instead of Regular Users

Related Articles