Test Execution API
Endpoint is /sso/ttapi/2.0/<mode>/<step>/authn
| Request | |||
| Parameters | Type | Values | Description |
| Authorization | Custom-Header | Bearer <authorization token> | request must include the authorization token retrieved before |
| mode | URL | nxt | only next step mode supported |
| step | URL | Integer [1-N] | test step to execute – must match a valid plan step. |
| ttin | JSON Parameter | SAML payload | SAML payload to generate the test message. Either raw SAML formatted or encoded in internal mode |
| plan | JSON Parameter | test plan | test plan which is returned by a preceding call |
Table 6
Sample request:
POST https://idp.ssocircle.com/sso/ttapi/2.0/nxt/1/authn HTTP/1.1
Host: idp.ssocircle.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:28.0) Gecko/20100101 Firefox/28.0
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
Accept-Language: en-US,en;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Bearer nN42C7bQnqzeTZi11fhPWd6cUwOwA17uq+ol5OyIT2o7888xiIMi3udG61j+3PfrUpmOe2adK+5
Ql3L1oK056w==
Content-Type: application/json; charset=UTF-8
Content-Length: 11291
{"ttin":"tT1f426191cc779a538bfaef9c12111284b20ba9043b28316f5df603a887fe1a4ad45212392b4b73259167ca
f440be8818b34da3c8e4eb8367da894b87cf98efae9187cce5f2ea1f858ede67279ea7a245fd05e8e27678684c083740
885ce44b7e63a527ad649e49eade3ea66eec817d8ed43a0f70c380dbcf857022fea50935c4293ab5a85a43165b4544b96
29e59ea879fdb2391f0039b4ee6dd85e3d93ff1a20332b77382b66d72d920c1d10c6cbc133487f03667d5115a7b02d0c4
52df1d7a1e214ff90eed0908e0c70fb1a11a6a7f87fbc3c74b4546b64a0b4d042024acf2631fa7566a8073fec6c25964c
6ddd471cb3e002ede7ddcb3487891e0276e975ce21f99bdb9f83b868e81ead5c5ed8d2694ff2a496f83d377296afb234e
5d450948e88a4ae2ab35bacff3e6884f17b2a9512d9005b5dacf3ce4510bbc08e993b8c7f4748c9b86dff3b0e98871d22
...
e3ea66eec817d8ed43a0f70c380dbcf857022fea50935c4293ab5a85a43165b4544b96",
"plan":"tT1624e223aa614b807695faca38fa8feea80ffe0fd215820bdf1100f2350ab224bf4bcc98d2a2f5208d3598c
9b904545c70d17081df0ca3b321401fb91fb2d67fc8df6c52897194b19082bf28cb8ef0f5ef2f692d38f49e9809d69748
dcf611b1ddfc6bde8880f3c4633ba21b5ec37f0de"}
| Response | |||
| Parameters | Type | Values | Description |
| plan | JSON | plan string | Plan string which holds the configuration for the next test step. |
| next | JSON | integer | The next test step to be executed |
| rule | JSON | integer | The rule which is applied to the result. See rule definition. |
| ttin | JSON | Request encoded or raw | SAMLResponse message in decoded (raw SAML) format that is used to execute the test |
| version | JSON | integer | The plan version. |
| HTTP Return codes | |||
| 200 | Successful | ||
| 402 | API access limit exceeded | ||
| 403 | Not authorized | ||
Table 7
Sample response:
200 OK
Server: "SSOCircle Web Server"
Date: Thu, 03 Apr 2014 13:57:20 GMT
Content-Length: 6033
Content-Type: application/json;charset=UTF-8
Set-Cookie: SSOCTT=tT1e26d10e92aafd858a6ddb19097abea4b1246a577f7788885fb0ad505ee20e39e418c352108e
772a353e4f13670072b1d3ed1ba8bc5afdaf7973824228444df1351981daa024ba8b3e0eecafe3c00739e; Path=/
{"plan":"tT19d5da75e69f5396d730372212b8c023acaa25bfd2ddcdd82f5176c9ae0b6869cb68d833f497edb6d52c25
6ac4869dbb375309888a00eff9b9c1c03029c0e6514e59b608a98cee57c70bf557b83acc270",
"next":41,
"rule":0,
"ttin":"PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6%0D%0AcHJvdG9
jb2wiIElEPSJzMjlhNDdmOTExZGQ1MDk1YjNiNzg2YjI1MWVkMDE1MTZhOTkxNjAxZTIi%0D%0AIEluUmVzcG9uc2VUbz0icz
I0OTg0ZjJmNzEyMTM3NTdkN2I3NzJkMzcxMWFkMjI5OGM2ZTZiYTQ0%0D%0AIiBWZXJzaW9uPSIyLjAiIElzc3VlSW5zdGFud
D0iMjAxNC0wNC0wM1QxMzoyMjoyOFoiIERlc3Rp%0D%0AbmF0aW9uPSJodHRwczovL2ZlZGxldC5pZHBlZS5jb206NDQzL3Nw
L2ZlZGxldGFwcGxpY2F0aW9u%0D%0AIj48c2FtbDpJc3N1ZXIgeG1sbnM6c2FtbD0idXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw
6Mi4wOmFz%0D%0Ac2VydGlvbiI%2BaHR0cDovL2lkcC5zc29jaXJjbGUuY29tPC9zYW1sOklzc3Vlcj48c2FtbHA6U3Rh%0D%
0AdHVzIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiPgo8%0D%0Ac2FtbHA6U3Rhd
...
mlidXRlPjwvc2FtbDpBdHRyaWJ1dGVTdGF0ZW1lbnQ%2BPC9zYW1sOkFzc2Vy%0D%0AdGlvbj48L3NhbWxwOlJlc3BvbnNlPg
%3D%3D",
"version":1}
