Skip to main content

HR Connect: Authentication

Emily Yeomans
  • Updated

What we’ll cover:

Applicable Roles:

  • HR Connect Administrator

Quick Reference Links:

Getting Started with Cayuse APIs

Before any call can be made to the Cayuse API, users must authenticate with Cayuse to obtain an authentication token. This token will be used for all subsequent requests to the Cayuse API.

The Bearer token returned will need to be used in Authorization headers for subsequent requests.

The tenant_id needed to make this call will be provided to you by your project manager during implementation.

Example:

# Authorization Header
“Authorization: Bearer $TOKEN”

API

Request:

Type

Value

 Description

Protocol

HTTPS

  

Method

GET

  

Host

https://signin.<environment>.cayuse.com

Host of the authentication API (please see note below)

URL

/basicauth

URL of the authentication API 

Query String Parameter

tenant_id

Specifies the tenant to use during authentication

Variable

Username

Used for constructing the Basic Auth header

Variable

Password

Used for constructing the Basic Auth header

 

Please note: URL is dependent on whether the environment is UAT (testing) or Prod (production).

  • UAT-AU (Testing for Australia Region): signin.train-au.cayuse.com
  • Prod-AU (Production for Australia Region): signin.prod-au.cayuse.com
  • UAT-CA (Testing for Canada Region): signin.train-ca.cayuse.com
  • Prod-CA (Production for Canada Region): signin.prod-ca.cayuse.com
  • UAT-SG (Testing for Asia Region): signin.train-sg.cayuse.com
  • Prod-SG (Production for Asia Region): signin.prod-sg.cayuse.com
  • UAT-UK (Testing for UK Region): signin.train-uk.cayuse.com
  • Prod-UK (Production for UK Region): signin.prod-uk.cayuse.com
  • UAT-US (Testing for US Region): signin.uat.cayuse.com
  • Prod-US (Production for US Region): signin.app.cayuse.com

Example:

# Provide the following values
USERNAME=
PASSWORD=
TENANT_ID=

# Call to obtain authentication token
curl --basic --user $USERNAME:$PASSWORD https://signin.<specify_environment_here>.cayuse.com/basicauth?tenant_id=$TENANT_ID

Response:

HTTP Status

Description

200 / 202

A JSON Web Token (JWT) will be returned in the body of the response.

401

Authentication was not successful.

500

Internal server error

 

Related articles