← Back to plugin index

Futurae Server
Description
Settings to configure access to Futurae servers.
Type name
FuturaeServer
Class
com.airlock.iam.factor.application.configuration.airlock2fa.FuturaeServerConfig
May be used by
Airlock 2FA Settings
License-Tags
Airlock2FA
Properties
Service ID (serviceId)
Description
The service ID of the client.

The value is of the form 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'.

Attributes
String
Mandatory
Auth API Key (authApiKey)
Description
The API key for the Futurae Auth API.
Attributes
String
Mandatory
Sensitive
Admin API Key (adminApiKey)
Description
The API key for the Futurae Admin API.

The Admin API key is different than the Auth API key, which is used to access the Auth API.

Attributes
String
Mandatory
Sensitive
Back-End Server URL (backEndUrl)
Description
The back-end URL of the Futurae server (without path or trailing slash).

This URL is used by the back-end of IAM to connect to the Futurae API.

Note: When using a custom URL and a CSP, add exceptions for img-src and connect-src directives with the configured URL to it.

Attributes
String
Optional
Validation RegEx: https?:\/\/[^\/]+
Default value
https://api.futurae.com
Front-End Server URL (frontEndUrl)
Description
The front-end URL of the Futurae server (without path or trailing slash).

This URL is used by the browser of the end user to access the Futurae API via the internet.

Note: When using a custom URL and a CSP, add exceptions for img-src and connect-src directives with the configured URL to it.

Attributes
String
Optional
Validation RegEx: https?:\/\/[^\/]+
Default value
https://api.futurae.com
Connect/Read Timeout [ms] (callTimeoutMs)
Description
The timeout (in milliseconds) that is used for requests to the Futurae server. The setting affects both the connection establishment and response reception. A value of zero is interpreted as 30 seconds.
Attributes
Integer
Optional
Default value
10000
Connection Pool Max Size (connectionPoolMaxSize)
Description
The maximum size of the connection pool that is used for requests to the Futurae server.
Attributes
Integer
Optional
Default value
50
Trust Store Path (trustStorePath)
Description
Keystore file name containing trusted certificate issuers (and trusted certificates).

If this property is not defined the following certificate issuers are trusted:

  • The list of issuers known to the Java VM if the system property "javax.net.ssl.trustStore" is not defined.
  • The list of issuers in a keystore referenced by system property "javax.net.ssl.trustStore" if defined in instance.properties using iam.java.opts

If this property is defined then the following certificate issuers are trusted:

  • The list of issuers in the referenced truststore file and no others.

In any case, IAM will only establish an HTTPS connection to the Futurae server or its proxy if the server certificate issuer is trusted or the certificate itself is trusted according to the aforementioned definition of trust.

Attributes
File/Path
Optional
Trust Store Password (trustStorePassword)
Description
The password used to check the integrity of the truststore, or to unlock the truststore.
Attributes
String
Optional
Sensitive
Key Store Path (keyStorePath)
Description
The keystore containing a client certificate (including a private key) for Airlock IAM. The client certificate is used to establish mutual SSL connections for HTTPS REST calls.
Attributes
File/Path
Optional
Key Store Password (keyStorePassword)
Description
The password used to check the integrity of the keystore, or to unlock the keystore. Must be provided in case the keystore is configured.
Attributes
String
Optional
Sensitive
Proxy URI (proxyUri)
Description
URI of a HTTP proxy the connector should use. If the port component of the URI is absent then a default port of 8080 is assumed. If this property is left empty then no proxy will be utilized.
Attributes
String
Optional
Example
https://proxy.company.com
Proxy Login User (proxyLoginUser)
Description
Username for the proxy if proxy authentication is used.
Attributes
String
Optional
Proxy Login Password (proxyLoginPassword)
Description
Password for the proxy if proxy authentication is used.
Attributes
String
Optional
Sensitive
YAML Template (with default values) 

type: FuturaeServer
id: FuturaeServer-xxxxxx
displayName: 
comment: 
properties:
  adminApiKey:
  authApiKey:
  backEndUrl: https://api.futurae.com
  callTimeoutMs: 10000
  connectionPoolMaxSize: 50
  frontEndUrl: https://api.futurae.com
  keyStorePassword:
  keyStorePath:
  proxyLoginPassword:
  proxyLoginUser:
  proxyUri:
  serviceId:
  trustStorePassword:
  trustStorePath: