Authentication

>>>

GET app.tenantoptions.com.au/api/auth/session
Callback on successful authentication

###Example Curl

curl -X GET "https://app.tenantoptions.com.au/api/auth/session#env=staging&api=ABC&access_token=CBA&state=valid"

curl -X GET "https://app.tenantoptions.com.au/api/auth/session_helper?env=staging&api=ABC&access_token=CBA&state=valid"

Errors

Code Description
501 Access token is required
502 State is required
503 Failed to save users access token

Params

Param name Description
access_token
required

The authentication token for Single Sign On

Validations:

  • Must be a String
env
optional

The API environment (either ‘staging’ or ‘production’)

Validations:

  • Must be a String
api
optional

The API region/state to be used within Australia (i.e. sa, qld, nt, nsw, vic, wa, act, taz)

Validations:

  • Must be a String
state
required

A value used for internal business logic

Validations:

  • Must be a String