Single Sign On

Request for SSO URL that provides authenticated access to KeyPay. See the guide on SSO Requests for more details.

Request

POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/employee/{employeeId}/singlesignon

Path parameters

Parameter name Value Description Additional
businessId string Required
employeeId string Required

Request body

The request body takes a complete SingleSignOnRequestModel resource, containing the following writable properties:

{
    "businessId": "int32",
    "hostName": "string",
    "navigation": "string",
    "url": "string",
    "userName": "string"
}

Properties

Name Type Description
businessId int32 Nullable
hostName string String
navigation string NavigationDisplayEnum

Possible values are:

  • Full
  • Primary
  • Secondary
  • None
  • HideInternalPageNav
url string String
userName string String

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

 SingleSignOnResponseModel