Latest revision as of 12:26, 16 November 2016

GET /accounts/{accountId}/avas/{domain}/SSOLink

Returns a SSO Link for the antispam control panel.

Request

GET/accounts/{accountId}/avas/{domain}/SSOLink

Request Parameters

accountId - string

The unique account Id.

domain - string

The domain that needs to be managed.

URI Parameters

None.

Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

Response

Status Code

200 OK

Success

401 Unauthorized

The request was sent without an Authorization header, or the user represented by the value of this header was not properly authenticated.

404 Not Found

The specified account or domain does not exist or is purged.

409 Conflict

The API was unable to generate a token

Response Body

{
  "ssoLink" : "{ssoLink}",
  "links" : [ {
    "href" : "https://api.hostway.com/accounts/{accountId}/avas/{domain}/SSOLink",
    "rel" : "self"
  } ]
}
 

Parameters

ssoLink - string

Contains a link for SSO login into the antispam control panel.

links - array

Hypermedia for this resource.

Examples

Successful Request

Request

GET /accounts/acc1234/avas/example.com/SSOLink
Authorization: Basic {Base64-encoded username & password string}
 

Response

200 OK

{
  "ssoLink" : "https://demo1.spambrand.com?authticket=1234567890abcdefghij1234567890abcdefghij",
  "links" : [ {
    "href" : "{APIBaseURL}/accounts/acc1234/avas/example.com/SSOLink",
    "rel" : "self"
  } ]
}