ZenDesk-SSO-Link-Per-Contact-Type:GET
From Hostway API Documentation
GET /accounts/{accountId}/contacts/{contactType}/supportSSOLink
Get contact details for an account.
Contents |
Request
GET /accounts/{accountId}/contacts/{contactType}/supportSSOLink
Request Parameters
- accountId - string
- The unique account Id.
- contactType - string
- The contact type that needs support SSO link.
- Note, there are 4 available types of contact information and you can request SSO link for one of them per request: "regular", "billing", "administrator" and "technical".
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.
- 403 Forbidden
- The email address of the user authenticated for this request is not verified.
- 404 Not Found
- The specified account Id or contact type for this account Id does not exist or is purged.
Response Body
{
"ssoLink" : "{ssoLink}",
"links" : [ {
"href" : "https://api.hostway.com/accounts/{accountId}/contacts/{contactType}/supportSSOLink/",
"rel" : "self"
} ]
}
Parameters
- ssoLink - string
- Contains a link for SSO login to ZenDesk platform.
- links - array
- Hypermedia for this resource.
Examples
Successful Request
Request
GET /accounts/{accountId}/contacts/{contactType}/supportSSOLink
Authorization: Basic {Base64-encoded username & password string}
Response
200 OK
{
"ssoLink" : "https://hostway.zendesk.com/access/jwt?jwt={authString}",
"links" : [ {
"href" : "https://api.hostway.com/accounts/{accountId}/contacts/{contactType}/supportSSOLink/",
"rel" : "self"
} ]
}
Request for SSO link of non-verified email
Request
GET /accounts/{AccountId}/contacts/{ContactType}/supportSSOLink
Authorization: Basic {Base64-encoded username & password string}
Response
403 Forbidden
{
"forbidden" : {
"guid" : "{identifier}",
"message" : "Email address is not verified",
"code" : 403,
"details" : ""
}
}
Request for non-existent account Id or contact Type
Request
GET /accounts/{fakeAccountId}/contacts/{fakeContactType}/supportSSOLink
Authorization: Basic {Base64-encoded username & password string}
Response
404 Not Found
{
"itemNotFound" : {
"guid" : "{identifier}",
"message" : "Resource not found",
"code" : 404,
"details" : ""
}
}
See also
