Credentials: Create Credential

Prev Next

Overview

The Create Credentials view allows you to define encrypted connection records for secure integration with external systems such as CMS platforms, FTP servers, Amazon S3, Google Cloud Storage, or REST APIs. These credentials enable secure data transfers by replacing sensitive data (e.g., usernames, passwords, API keys) with placeholder values.


Navigation Path

  1. Main Navigation > User Management > Permissions > Credentials

  2. Click Create


Global Settings

Setting

Description

Name

Required. Unique identifier for the credential. Must be lowercase alphanumeric (max 50 characters). Cannot be changed after saving. Used for placeholder referencing.

Description

Optional. Helps describe the purpose of the credential record.

Type

Required. Selects the type of credential. Controls which additional input fields appear. Options include: User Name, User Password, User Account, CMS Account, FTP Server, Rest Endpoint, Token Certificate Account, Amazon S3 Account, Google Storage Account.

Add Credential Parameter

Optional. Adds a custom key-value pair (e.g., header, body, or query). Parameters can be marked as “Secret” to mask values in the UI.

After saving, each credential record generates one or more system placeholders based on the Name field. These placeholders are used in paths, headers, or API bodies and automatically reference the encrypted values.


Type-Specific Settings

User Name

Field

Description

User Name

Username to be encrypted and replaced by the record name in secure transfers.

User Password

Field

Description

Password

Required. Password to be encrypted.

Confirm Password

Must match the password field.

User Account

Field

Description

User Name

Username to be encrypted.

Password

Password associated with the user account.

Confirm Password

Must match the password field.

CMS Account

Field

Description

URL

External system URL. Must follow https://secure.ecircle-ag.com/systemname.

User Name

CMS user name.

Password

CMS password.

Confirm Password

Must match the password field.

Only one active CMS Account record is allowed.

FTP Server

Field

Description

File Location

Path to the FTP server (e.g., sftp://servername/path). Only secure SFTP is supported.

Account Name

Required. Username for FTP access.

Password

Required. Password for the account.

Confirm Password

Must match the password field.

Rest Endpoint

Field

Description

Path

API endpoint path (e.g., https://example.com/api/upload).

Account Name

Username for authentication.

Password

Password for the account.

Confirm Password

Must match the password field.

Token Certificate Account

Field

Description

Path

API endpoint for obtaining the token.

User Key

User-specific identifier.

API Key

Token key for authentication.

XPath to Token in Response Body

XPath to extract token from the API response (e.g., //[local-name()='AuthToken']//text()).

Request Body

Payload required to initiate the token request.

Use Test Connection to validate the credentials and preview the response.

Amazon S3 Account

Field

Description

User Key

AWS access key ID.

Secret Key

AWS secret access key.

Region Name

AWS region of the bucket (e.g., eu-central-1).

Bucket Name

Name of the target S3 bucket.

Only one credential record is allowed per Amazon S3 bucket.

Google Storage Account

Field

Description

JSON File Upload

Upload the Google Cloud service account credentials in JSON format.

Google Project ID

The Google Cloud project ID associated with the bucket.

Storage Bucket Name

Name of the bucket to be accessed.

Only one credential record is allowed per bucket. Only service accounts are supported (not user accounts).


Actions Table

Action

Description

Save

Saves the credential and activates it for immediate use.

Cancel

Cancels the operation and discards all entries.

Test Connection

Available only for Token Certificate Account. Tests API access and shows the response.


Additional Information

  • Once saved, the Name is used to create non-editable placeholders (e.g., ${encryption.user-test.name} or ${encryption.cms-account-test.cmsAccountURL}).

  • These placeholders are automatically updated by the system with the latest credential values and do not need to be manually replaced in existing configurations.

  • When editing credentials later, values like passwords or API keys can be changed without affecting the placeholder structure.