logoBack to home screen

Authenticating to ADx via REST

To authenticate to your ADx instance, send a request to the https://host:port/tribefire-services/api/v1/authenticate endpoint. As a result, a session ID is returned - you can use it in other requests. Use the endpoint as explained below:

Request typeService descriptionEndpointRequest query parametersReturns
POSTGet session IDhttps://host:port/tribefire-services/api/v1/authenticateuser, passwordsessionId

Parameters

ParameterData typeDescription
userstringuser name used for authentication
passwordstringpassword used for authorization
sessionIdstringsessionId getting returned

cURL Example

The request shown below will return a session ID from https://adx-local:8443. user and password (cortex/cortex) are passed in the request body.

curl --location --request POST 'https://adx-local:9080/tribefire-services/api/v1/authenticate?user=cortex&password=cortex' \
--header 'Content-Type: application/json'

Configuring Sessions

You can configure the maximum idle time and the usage of session cookies which allow you to keep the session alive after the browser has been closed. To do it, modify TRIBEFIRE_USER_SESSIONS_MAX_IDLE_TIME and TRIBEFIRE_RUNTIME_OFFER_STAYSIGNED runtime properties in accordance with your needs when installing ADx.

  # Specifies how long a user session should remain active when there is no activity on the session.
  # After the specified inactive time has passed (i.e. no request with the corresponding session ID has been received by the server),
  # the session is flagged as inactive and consequently removed by a periodic cleanup process.
  # The time span can be specified as a human-readable string, using numbers and the time unit, as in 12h, 30m, 3600s, etc.
  TRIBEFIRE_USER_SESSIONS_MAX_IDLE_TIME: "30m"

  # When this is set to true, the login dialog will offer an option to stay signed-in after a browser restart.
  # If this is set to false, the user session will always be closed when the browser is closed.
  # This is achieved by using a session cookie that stores the user's session ID until the browser is closed.
  TRIBEFIRE_RUNTIME_OFFER_STAYSIGNED: "true"