API Key Glossary

  • Updated on Oct 8, 2025
  • Published on Oct 8, 2025
  • 1 minute(s) read
Prev Next

UI Field

API Name

Description

Category

Username

userId

Unique identifier of the user within the system.

common

Username

username

The login name or handle associated with the user.

common

Customer ID

customerId

Identifier of the customer account linked to the user.

common

globalAdmin

Boolean flag indicating whether the user has global administrator rights.

common

Customer Access

rights

List of customer-specific rights and roles assigned to the user.

common

rights.customerId

Customer account for which the role is valid.

rights

rights.roles

Roles granted to the user (e.g., CustomerAdmin).

rights

Created

created

Timestamp when the user account was created.

common

Created By

createdBy

User or system account that created this user.

common

Last Update

lastUpdated

Timestamp of the most recent update to the user account.

common

Last Updated by

lastUpdatedBy

User or system account that performed the last update.

common

API Key

apiKey

API key associated with the user for programmatic access.

common