Reference

Configuration Fields Reference

Complete reference guide for all Licentra configuration fields in NetSuite. This page provides detailed information about each field, its purpose, and valid values.

See More: Licentra Wiki – Modules

Licentra Config Record Fields

Primary Configuration Fields

Field	Type	Required	Default	Description
License Server URL	Text	Yes	-	Base URL for Licentra API server
Client Id	Text	Yes	-	Unique identifier for your NetSuite client
Client Secret Reference	Text	Yes	-	Internal ID of the API Secret record
Signature Type	Select	No	HS256	Cryptographic algorithm for API requests

License Server URL

Purpose

Specifies the base URL for the Licentra API server that your NetSuite instance will communicate with.

Valid Values

Development/Sandbox Environment

Code
 
https://beta.licentra.api.bringitproducts.com/

Custom Environment

Contact your Licentra administrator for custom server URLs.

Format Requirements

Must be a valid HTTPS URL
No trailing slash required
Must be accessible from your NetSuite instance

Client Id

Purpose

Unique identifier that links your NetSuite instance to your Licentra client account.

Characteristics

Format: Alphanumeric string
Length: Typically 8-32 characters
Case: Case-sensitive
Uniqueness: Must be unique across all Licentra clients

How to Obtain

Log into your Licentra portal
Navigate to Client Configuration section
Copy the Client ID value
Store securely for configuration

Examples

Code
 
✅ Valid: client_12345
✅ Valid: netsuite_prod_2024
✅ Valid: ABC123DEF456
❌ Invalid: client-12345 (hyphens not allowed)
❌ Invalid: 12345 (too short)

Client Secret Reference

Purpose

Internal NetSuite reference to the API Secret record containing your License Secret.

Characteristics

Format: NetSuite internal ID
Source: Created when you create an API Secret record
Relationship: Links Config record to API Secret record

How to Set

Create an API Secret record first
Note the ID you assigned to the secret
Enter that ID in this field
Save the Config record

Examples

Code
 
✅ Valid: licentra_api_secret
✅ Valid: netsuite_prod_secret
✅ Valid: licentra_integration_key
❌ Invalid: (empty field)
❌ Invalid: non_existent_secret_id

Signature Type

Purpose

Specifies the cryptographic algorithm used for signing API requests between NetSuite and Licentra.

Available Options

Value	Algorithm	Security Level	Performance	Recommendation
HS256	HMAC-SHA256	High	Fast	✅ Recommended
RS256	HMAC-SHA256	Higher	Medium	Not supported for now

Default Value

HS256 - HMAC-SHA256 (recommended for most environments)

Selection Guidelines

HS256: Suitable for most production environments
RS256: TBD

API Secret Record Fields

Secret Configuration Fields

Field	Type	Required	Description
Name	Text	Yes	Descriptive name for the secret
ID	Text	Yes	Internal identifier (used in Config record)
Password	Password	Yes	The actual License Secret value
Description	Text	No	Optional context information
Restrictions	Checkbox	Yes	Allow for all Scripts

API Secret Name

Purpose

Human-readable identifier for the API Secret record.

Best Practices

Use descriptive, memorable names
Include environment information
Avoid generic terms like "secret" or "key"

Examples

Code
 
✅ Good: Licentra Production Integration Secret
✅ Good: NetSuite Prod - Licentra API Key
✅ Good: Licentra License Manager Secret
❌ Poor: Secret
❌ Poor: API Key
❌ Poor: Licentra

API Secret ID

Purpose

Internal identifier used to reference this secret in the Licentra Config record.

Characteristics

Format: Alphanumeric string
Length: 3-50 characters
Case: Case-sensitive
Uniqueness: Must be unique within your NetSuite instance

Naming Conventions

Code
 
✅ Good: licentra_prod_secret
✅ Good: netsuite_licentra_api
✅ Good: licentra_integration_key
❌ Avoid: spaces or special characters
❌ Avoid: very long names

API Secret Password

Purpose

Stores the actual License Secret value from your Licentra subscription.

Security Requirements

Confidentiality: Never share or expose this value
Accuracy: Copy exactly from Licentra portal
Storage: Securely stored in NetSuite API Secrets

Format

Length: Variable (typically 32-64 characters)
Characters: Alphanumeric and special characters
Case: Case-sensitive

Examples

Code
 
✅ Valid: sk_live_1234567890abcdef1234567890abcdef
✅ Valid: licentra_secret_2024_abc123def456ghi789
❌ Invalid: (empty value)
❌ Invalid: (copied with extra spaces)

API Secret Description

Purpose

Optional field providing context about the secret's purpose and usage.

Content Suggestions

Purpose of the integration
Environment information
Creation date or version
Contact information for questions

Examples

Code
 
✅ Good: API Secret for Licentra License Manager Integration - Production Environment
✅ Good: Licentra integration secret created 2024-01-15 for NetSuite production instance
✅ Good: Used by Licentra bundle scripts for license validation and enforcement

API Secret Restrictions

Purpose

Controls which NetSuite scripts can access this secret.

Required Setting

"Allow for all Scripts" must be checked
This enables Licentra bundle scripts to access the secret
Required for license validation and enforcement

Security Note

This setting is necessary for Licentra functionality
The secret is only accessible by authorized NetSuite scripts
Additional security is provided by NetSuite's script execution environment

Field Dependencies

Configuration Order

Create API Secret first
Note the Secret ID
Create Licentra Config record
Reference the Secret ID in Client Secret Reference field

Validation Rules

License Server URL: Must be valid HTTPS URL
Client Id: Must match Licentra portal value exactly
Client Secret Reference: Must reference existing API Secret
Signature Type: Must be valid algorithm option

Advanced Configuration

Multiple Environments

For organizations with multiple NetSuite instances:

Code
 
# Production Environment
Config Record: Licentra Production Config
Secret Record: licentra_prod_secret
Server URL: https://production.licentra.api.bringitproducts.com

# Development Environment
Config Record: Licentra Development Config
Secret Record: licentra_dev_secret
Server URL: https://development.licentra.api.bringitproducts.com

Custom Signature Types

Advanced security configurations:

Code
 
# Enhanced Security
Signature Type: HS384
# Maximum Security
Signature Type: HS512

Need Help?

If you need assistance with configuration fields:

Review field descriptions and examples above
Check the troubleshooting guides for common issues
Contact your Licentra administrator for credential questions
Reach out to BringIT support for technical assistance

Last modified on July 18, 2025

API Secrets Management Environment URLs Reference