Authenticating

The FireFlow REST API uses cookie-based authentication. The authentication request returns a sessionId that you use to manually create a cookie. The cookie is required for all other API requests.

Resource Name: /FireFlow/api/authentication/authenticate

Request Method: POST

Request Body:

Element

Type

Description
usernameMandatory

String

AlgoSec Security Management Suite username.
passwordMandatory

String

AlgoSec Security Management Suite password.
domainOptional

String

Domain name.

Relevant only when domains are enabled.

Default: null
Response Body:

Element

Type

Description
status

String

One of the following:

    SuccessFailure
messages

List of strings

The code and message. See below.
code

String

One of the following:

    success
    authentication.failure
message

String

One of the following:

    Success
    Authentication Failed
data

List of strings

In the case of a success, the sessionId, faSessionId, and phpSessionId.

In case of failure, the value is null.

Example Request:

{"username":"admin","password":"algosec","domain":null}

Example Response (Success):

{

"status": "Success",

"messages": [

{

"code": "success",

"message": "Success"

}

],

"data": {

"sessionId": "adaa420aaf8fc37bfae506ecd742ab75",

"faSessionId": "a5326bb7a200d3984de6a2533af5b351",

"phpSessionId": "PHPSESSID=n1rgrme4mi5m9cj51jfp4rbc07; path=/; secure; HttpOnly"

}

}

Example Response (Failure):

{

"status": "Failure",

"messages": [

{

"code": " authentication.failure",

"message": "Authentication Failed"

}

],

"data": null

}