HTTP request parameter.

HTTP POST request body.

HTTP request header.

roles configuration object

Properties

The _type property distinguish the origin of a template. 'core' templates are added from the /mod/workspace/templates directory. A 'custom' is added from a custom_template JSON file defined in the xyzEnv. A 'workspace' is added from the workspace itself. A _type='template' object is assigned in the assignWorkspaceTemplates method.

The source is a location from which a template object is loaded when required. Once loaded the template will be cached.

The cached template.

The string representation of a template, eg. html, sql.

A method which resolves in a template string.

The template is a module.

Each property of the roles object is a role which can be assigned to a user.

The fallback dbs connection if not implicit in [query] template.

The default locale which serves as a templates for all locales in workspace.

Each property in the locales object is a locale available from this workspace.

The XYZ API path which concatenated with the domain for all requests.

DBS_* values are the connections used to establish connections to pg servers with the dbs module.

The port on which the express app listens to for requests.

The Time To Live for all cookies issued by the XYZ API.

The TITLE value is used to identify cookies and is provided to as a param to Application View templates.

The LOGS string will split on comma to determine which requests send to the LOGGER module will be logged.

Required to configure the LOGGER module for a remote out.

Maximum requests per window in the express module

Time window in ms in the express module

All requests to XYZ API require authentication. The PRIVATE value represents the ACL connection.

General requests to XYZ API do require authentication. The PUBLIC value represents an ACL connection for optional authentication.

A secret string is required to sign and validate JWT.

The auth module will store and check a session key if the USER_SESSION xyzEnv is not undefined.

The user/fromACL module can expiry user authorization if the AUTH_EXPIRY xyzEnv is configured.

The user/fromACL module will expire user validation if failed login attempts exceed the FAILED_ATTEMPTS value.

The user/register module will apply PASSWORD_REGEXP value to check the complexity of provided user passwords.

The utils/dbs module will apply the STATEMENT_TIMEOUT to the query.client.

The utils/dbs module will apply the RETRY_LIMIT to the query.client.

The workspace/cache module flashes the workspace cache after the WORKSPACE_AGE is reached.

The workspace/cache module caches templates defined as a src in the CUSTOM_TEMPLATES xyzEnv.

The utils/mailer module requires a TRANSPORT xyzEnv.

The hostname or IP address that the utils/mailer module module connects to.

The optional hostname of the client, used for identifying to the server in the utils/mailer module module.

The email used to send emails in the utils/mailer module module.

The username used to authenticate in the utils/mailer module module.

The password used to authenticate in the utils/mailer module module.

The port used to connect to the host in the utils/mailer module module.

defines additional node.js TLSSocket options to be passed to the socket constructor used in the utils/mailer module module.

The user/register module will limit the registration to user emails for domains provided in the comma seperated USER_DOMAINS xyzEnv.

SRC_* values will replace the key wildcard [*] in the stringified workspace.

A key [*.pem] file matching the KEY_CLOUDFRONT value is required for authentication requests in the cloudfront provider module.

A AWS_S3_CLIENT xyzEnv is required to sign requests with the s3 signer module.

A CLOUDINARY_URL xyzEnv is required to sign requests with the cloudinary signer module.

Assertion Consumer Service URL where SAML responses are received

Single Sign-On URL of the Identity Provider

Single Logout URL for terminating sessions

Service Provider Entity ID (your application identifier)

Path to IdP certificate file for validation

Base name for SP certificate pair files

Require signed assertions (true/false)

Require signed responses (true/false)

Algorithm for signing (e.g., 'sha256')

Format for name identifiers

Allowed time difference in ms

Display name for your service

URL for handling logout callbacks