Authenticated ‘Ping’#
Use /authenticate
to check whether server is alive or not with authentication details.
You can also use this URL to test if your authentication logic in the client-app is correctly implemented.
Route
/authenticate
Headers#
Key | Value Type | Description |
---|---|---|
X-FLYNN-N-ORG-ID | Non-sensitive, String | Organization (ID) on behalf of which the request is made |
X-FLYNN-N-USER-TOKEN | Sensitive, Base64 String | Authentication token carrying necessary information of the user making the request. Authentication server here is theodore . |
Content-Type | It used to indicate the media type of the resource in the request for example: application/json for json document exchange |
|
accept | It used to request the media type of the resource expected in the response for example: application/json for json document exchange |
Response#
200
:#
Successful 'Ping'
- i.e., you are able to make ‘authenticated’ call
Example
{
"data": {
"message": "pong"
}
}
Errors (4xx
and 5xx
):#
Common Errors
check documentation for common errors - here.