API Reference
Authentication
This endpoint is to check your API request and test if it is working by authenticating your user profile.
POST
/
authentication
Authorization
curl --request POST \
--url https://api.worqhat.com/authentication \
--header 'Authorization: <authorization>'
{
"orgName": "example_org",
"processing_id": "cd185dd4-fcfb-4b15-93de-db9eded23ade",
"processing_time": 2311,
"status": "success",
"userDisplayName": "John Doe",
"userEmail": "user@example.com"
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
200 - application/json
orgName
string
The organization name associated with the authenticated user.
processing_id
string
A universally unique identifier for the request. This can be used to track the request in the logs.
processing_time
integer
The time taken to process the request, in milliseconds.
status
string
Status indicating the success of the authentication.
userDisplayName
string
The display name of the authenticated user.
userEmail
string
The email address of the authenticated user.
Was this page helpful?
curl --request POST \
--url https://api.worqhat.com/authentication \
--header 'Authorization: <authorization>'
{
"orgName": "example_org",
"processing_id": "cd185dd4-fcfb-4b15-93de-db9eded23ade",
"processing_time": 2311,
"status": "success",
"userDisplayName": "John Doe",
"userEmail": "user@example.com"
}