| GET,OPTIONS | /login/sso | Validates a user from SSO via JWT and returns an object that contains whether the attempt was successful and the URL for the next page to navigate to. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Request | query | IRequest | No | |
| ReturnUrl | Query | string | No | A page's URL to return the user to. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OriginalRequest | form | Object | No | |
| Response | form | IResponse | No | |
| OperationName | form | string | No | |
| Verb | form | string | No | |
| RequestAttributes | form | RequestAttributes | No | |
| RequestPreferences | form | IRequestPreferences | No | |
| Dto | form | Object | No | |
| ContentType | form | string | No | |
| IsLocal | form | bool | No | |
| UserAgent | form | string | No | |
| Cookies | form | IDictionary<string, Cookie> | No | |
| ResponseContentType | form | string | No | |
| HasExplicitResponseContentType | form | bool | No | |
| Items | form | Dictionary<string, Object> | No | |
| Headers | form | NameValueCollection | No | |
| QueryString | form | NameValueCollection | No | |
| FormData | form | NameValueCollection | No | |
| UseBufferedStream | form | bool | No | |
| RawUrl | form | string | No | |
| AbsoluteUri | form | string | No | |
| UserHostAddress | form | string | No | |
| RemoteIp | form | string | No | |
| Authorization | form | string | No | |
| IsSecureConnection | form | bool | No | |
| AcceptTypes | form | string[] | No | |
| PathInfo | form | string | No | |
| OriginalPathInfo | form | string | No | |
| ContentLength | form | long | No | |
| Files | form | IHttpFile[] | No | |
| UrlReferrer | form | Uri | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OriginalResponse | form | Object | No | |
| Request | form | IRequest | No | |
| StatusCode | form | int | No | |
| StatusDescription | form | string | No | |
| ContentType | form | string | No | |
| Dto | form | Object | No | |
| UseBufferedStream | form | bool | No | |
| IsClosed | form | bool | No | |
| KeepAlive | form | bool | No | |
| HasStarted | form | bool | No | |
| Items | form | Dictionary<string, Object> | No |
| Name | Value |
|---|---|
| None | 0 |
| Localhost | 1 |
| LocalSubnet | 2 |
| External | 4 |
| Secure | 8 |
| InSecure | 16 |
| AnySecurityMode | 24 |
| HttpHead | 32 |
| HttpGet | 64 |
| HttpPost | 128 |
| HttpPut | 256 |
| HttpDelete | 512 |
| HttpPatch | 1024 |
| HttpOptions | 2048 |
| HttpOther | 4096 |
| AnyHttpMethod | 8160 |
| OneWay | 8192 |
| Reply | 16384 |
| AnyCallStyle | 24576 |
| Soap11 | 32768 |
| Soap12 | 65536 |
| Xml | 131072 |
| Json | 262144 |
| Jsv | 524288 |
| ProtoBuf | 1048576 |
| Csv | 2097152 |
| Html | 4194304 |
| Wire | 8388608 |
| MsgPack | 16777216 |
| FormatOther | 33554432 |
| AnyFormat | 67076096 |
| Http | 67108864 |
| MessageQueue | 134217728 |
| Tcp | 268435456 |
| Grpc | 536870912 |
| EndpointOther | 1073741824 |
| AnyEndpoint | 2080374784 |
| InProcess | -2147483648 |
| InternalNetworkAccess | -2147483645 |
| AnyNetworkAccessType | -2147483641 |
| Any | -1 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcceptsGzip | form | bool | No | |
| AcceptsDeflate | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| FileName | form | string | No | |
| ContentLength | form | long | No | |
| ContentType | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| success | form | bool | No | |
| redirect | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /login/sso HTTP/1.1 Host: api.paylock.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
success: False,
redirect: String
}