Home Features Tour Pricing
Blog Support Contact us
Call us today on +44 (0)1227 812932 Get your FREE Trial

Controller : Authenticate

VERSION: 4.0, DEPRECATED: NO

Token should be obtained using client created nonce + supplied client_secret and hashed using SHA512 algorithm, then sent in as the 'secret' value.Nonce's cannot be used more then once.

with-credentials with-access-token Return to API overview

Calls: {root}/authenticate

POSTwith credentials

Route: {root}/v4/authenticate/with-credentials
Request type User level Requires authentication Response type
BODY NONE No Single

Params

Name Type Nullable? Required? Min. Max. Nest Custom
username STRING REQUIRED 1 250 - -
password STRING REQUIRED 1 50 - -
ip_address STRING OPTIONAL 0 15 - -
nonce STRING REQUIRED 1 32 - -
secret STRING REQUIRED 1 160 - -
app_id STRING REQUIRED 1 16 - -
delay [BOOLEAN] ✓ OPTIONAL - -
cURL
curl --location --request POST "{{ROOT}}authenticate/with-credentials/" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"username": "sample","password": "sample","ip_address": "sample","nonce": "sample","secret": "sample","app_id": "sample","delay": false}'

Response object 
[
    {
      "object_name":"token",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"access_token",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"token_expiry_date",
                "type":"DateTime",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  },
    {
      "object_name":"user",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"user_id",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"first_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"last_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"email_address",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"user_type_id",
                "type":"custom",
                "is_nullable":False,
                "nest":null,
                "custom":"[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"approver plus add",
                "value":"210"
            },
            {
                "name":"approver plus add edit cancel",
                "value":"220"
            },
            {
                "name":"super user",
                "value":"300"
            },
            {
                "name":"super user with staff hub",
                "value":"310"
            }]"
                "note":"",
            },
            {
                "object_name":"department_id",
                "type":"Int32",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"company_alerts",
                "type":"Int32",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"branding_css",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"company_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"overtime_access",
                "type":"Boolean",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"cross_department_recording_id",
                "type":"custom",
                "is_nullable":False,
                "nest":null,
                "custom":"[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"super user",
                "value":"300"
            },
            {
                "name":"super user with staff hub",
                "value":"310"
            }]"
                "note":"",
            },
            {
                "object_name":"cross_department_recording_leave_type_id",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"cross_department_view_id",
                "type":"custom",
                "is_nullable":False,
                "nest":null,
                "custom":"[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"super user",
                "value":"300"
            },
            {
                "name":"super user with staff hub",
                "value":"310"
            }]"
                "note":"",
            },
            {
                "object_name":"default_view_id",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"default_view_type_id",
                "type":"custom",
                "is_nullable":False,
                "nest":null,
                "custom":"[
            {
                "name":"department",
                "value":"1"
            },
            {
                "name":"tag",
                "value":"2"
            }]"
                "note":"",
            },
            {
                "object_name":"default_sorting_id",
                "type":"[Byte]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"force_mfa",
                "type":"[Boolean]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"start_month",
                "type":"custom",
                "is_nullable":False,
                "nest":null,
                "custom":"[
            {
                "name":"january",
                "value":"1"
            },
            {
                "name":"february",
                "value":"2"
            },
            {
                "name":"march",
                "value":"3"
            },
            {
                "name":"april",
                "value":"4"
            },
            {
                "name":"may",
                "value":"5"
            },
            {
                "name":"june",
                "value":"6"
            },
            {
                "name":"july",
                "value":"7"
            },
            {
                "name":"august",
                "value":"8"
            },
            {
                "name":"september",
                "value":"9"
            },
            {
                "name":"october",
                "value":"10"
            },
            {
                "name":"november",
                "value":"11"
            },
            {
                "name":"december",
                "value":"12"
            }]"
                "note":"",
            },
            {
                "object_name":"start_day",
                "type":"custom",
                "is_nullable":False,
                "nest":null,
                "custom":"[
            {
                "name":"day 1",
                "value":"1"
            }]"
                "note":"",
            },
            {
                "object_name":"company_sign_up_year",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"staff_hub_permission",
                "type":"ResObjAuthenticateStaffHub",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  },
    {
      "object_name":"mfa_challenge",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"no challenge",
                "value":"0"
            },
            {
                "name":"challenge",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"account_status_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"active",
                "value":"1"
            },
            {
                "name":"in transfer merge",
                "value":"2"
            },
            {
                "name":"cancelled",
                "value":"3"
            },
            {
                "name":"on hold no card",
                "value":"4"
            },
            {
                "name":"transferred",
                "value":"5"
            },
            {
                "name":"on hold failed",
                "value":"6"
            },
            {
                "name":"suspended",
                "value":"7"
            }]
      "note": 
  },
    {
      "object_name":"saml",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"idp_callback",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"provider_id",
                "type":"[Byte]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  },
    {
      "object_name":"force_saml",
      "type":"[Boolean]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]


POSTwith access token

Route: {root}/v4/authenticate/with-access-token
Request type User level Requires authentication Response type
BODY NONE No Single

Params

Name Type Nullable? Required? Min. Max. Nest Custom
access_token STRING REQUIRED 32 32 - -
ip_address STRING OPTIONAL 1 15 - -
nonce STRING REQUIRED 1 32 - -
secret STRING REQUIRED 1 160 - -
app_id STRING REQUIRED 1 16 - -
cURL
curl --location --request POST "{{ROOT}}authenticate/with-access-token/" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"access_token": "sample","ip_address": "sample","nonce": "sample","secret": "sample","app_id": "sample"}'

Response object 
[
    {
      "object_name":"token",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"access_token",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"token_expiry_date",
                "type":"DateTime",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  },
    {
      "object_name":"user",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"user_id",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"first_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"last_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"email_address",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"user_type_id",
                "type":"custom",
                "is_nullable":False,
                "nest":null,
                "custom":"[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"approver plus add",
                "value":"210"
            },
            {
                "name":"approver plus add edit cancel",
                "value":"220"
            },
            {
                "name":"super user",
                "value":"300"
            },
            {
                "name":"super user with staff hub",
                "value":"310"
            }]"
                "note":"",
            },
            {
                "object_name":"department_id",
                "type":"Int32",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"company_alerts",
                "type":"Int32",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"branding_css",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"company_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"overtime_access",
                "type":"Boolean",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"cross_department_recording_id",
                "type":"custom",
                "is_nullable":False,
                "nest":null,
                "custom":"[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"super user",
                "value":"300"
            },
            {
                "name":"super user with staff hub",
                "value":"310"
            }]"
                "note":"",
            },
            {
                "object_name":"cross_department_recording_leave_type_id",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"cross_department_view_id",
                "type":"custom",
                "is_nullable":False,
                "nest":null,
                "custom":"[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"super user",
                "value":"300"
            },
            {
                "name":"super user with staff hub",
                "value":"310"
            }]"
                "note":"",
            },
            {
                "object_name":"default_view_id",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"default_view_type_id",
                "type":"custom",
                "is_nullable":False,
                "nest":null,
                "custom":"[
            {
                "name":"department",
                "value":"1"
            },
            {
                "name":"tag",
                "value":"2"
            }]"
                "note":"",
            },
            {
                "object_name":"default_sorting_id",
                "type":"[Byte]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"force_mfa",
                "type":"[Boolean]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"start_month",
                "type":"custom",
                "is_nullable":False,
                "nest":null,
                "custom":"[
            {
                "name":"january",
                "value":"1"
            },
            {
                "name":"february",
                "value":"2"
            },
            {
                "name":"march",
                "value":"3"
            },
            {
                "name":"april",
                "value":"4"
            },
            {
                "name":"may",
                "value":"5"
            },
            {
                "name":"june",
                "value":"6"
            },
            {
                "name":"july",
                "value":"7"
            },
            {
                "name":"august",
                "value":"8"
            },
            {
                "name":"september",
                "value":"9"
            },
            {
                "name":"october",
                "value":"10"
            },
            {
                "name":"november",
                "value":"11"
            },
            {
                "name":"december",
                "value":"12"
            }]"
                "note":"",
            },
            {
                "object_name":"start_day",
                "type":"custom",
                "is_nullable":False,
                "nest":null,
                "custom":"[
            {
                "name":"day 1",
                "value":"1"
            }]"
                "note":"",
            },
            {
                "object_name":"company_sign_up_year",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"staff_hub_permission",
                "type":"ResObjAuthenticateStaffHub",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  },
    {
      "object_name":"mfa_challenge",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"no challenge",
                "value":"0"
            },
            {
                "name":"challenge",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"account_status_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"active",
                "value":"1"
            },
            {
                "name":"in transfer merge",
                "value":"2"
            },
            {
                "name":"cancelled",
                "value":"3"
            },
            {
                "name":"on hold no card",
                "value":"4"
            },
            {
                "name":"transferred",
                "value":"5"
            },
            {
                "name":"on hold failed",
                "value":"6"
            },
            {
                "name":"suspended",
                "value":"7"
            }]
      "note": 
  },
    {
      "object_name":"saml",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"idp_callback",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"provider_id",
                "type":"[Byte]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  },
    {
      "object_name":"force_saml",
      "type":"[Boolean]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]

INSTANTLY REDUCE TIME SPENT ON LEAVE MANAGEMENT

Get your long FREE trial today!

No obligation and no payment setup required.
Sign up today and get until Sunday, 26th January 2025 to try the full service, for Free!
 

Start Your Free Trial

Cookie settings for whosoff.com

We use cookies to improve our website experience, we also use cookies to help us undertand how our website is used, enhance site navigation and analyze site usage and advertising. For more information please refer to our Cookie Policy.

AdvertisingEnables storage related to advertising, for example, advertising campaign.
AnalyticsEnables storage related to analytics, for example, visit duration.
TargetingSets consent for sending user data to Google for online advertising purposes.
MarketingSets consent for personalized advertising.
Manage cookies