Skip to content

SsoApi.md

Latest commit

 

History

History
181 lines (119 loc) · 7.15 KB

SsoApi.md

File metadata and controls

181 lines (119 loc) · 7.15 KB

SsoApi

All URIs are relative to https://secure.ultracart.com/rest/v2

Method HTTP request Description
getSsoSessionUser GET /sso/session/user Get single sign on session user
ssoAuthorize PUT /sso/authorize Authorize a single sign on session
ssoSessionRevoke DELETE /sso/session/revoke Revoke single sign on session
ssoToken PUT /sso/token Exchange a single sign on code for a simple key token

getSsoSessionUser

User getSsoSessionUser()

Get single sign on session user

This is the equivalent of logging out of the single sign on session

Example

// (Internal API).  No sample for this method as a merchant will never need call it.

Parameters

This endpoint does not need any parameter.

Return type

User

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

ssoAuthorize

SingleSignOnAuthorizeResponse ssoAuthorize(authorizationRequest)

Authorize a single sign on session

Starts the process of authorizing a single sign on session.

Example

// (Internal API).  No sample for this method as a merchant will never need call it.

Parameters

Name Type Description Notes
authorizationRequest SingleSignOnAuthorizeRequest Authorization request

Return type

SingleSignOnAuthorizeResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json; charset=UTF-8
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

ssoSessionRevoke

ssoSessionRevoke()

Revoke single sign on session

This is the equivalent of logging out of the single sign on session

Example

// (Internal API).  No sample for this method as a merchant will never need call it.

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

ssoToken

SingleSignOnTokenResponse ssoToken(tokenRequest)

Exchange a single sign on code for a simple key token

Called by your application after receiving the code back on the redirect URI to obtain a simple key token to make API calls with

Example

// (Internal API).  No sample for this method as a merchant will never need call it.

Parameters

Name Type Description Notes
tokenRequest SingleSignOnTokenRequest Token request

Return type

SingleSignOnTokenResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json; charset=UTF-8
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message