GET | /auth | Logs in using Jiwa username and password | Username and password must be provided. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
provider | query | string | No | |
State | query | string | No | |
oauth_token | query | string | No | |
oauth_verifier | query | string | No | |
UserName | query | string | No | |
Password | query | string | No | |
RememberMe | query | bool? | No | |
Continue | query | string | No | |
nonce | query | string | No | |
uri | query | string | No | |
response | query | string | No | |
qop | query | string | No | |
nc | query | string | No | |
cnonce | query | string | No | |
UseTokenCookie | query | bool? | No | |
AccessToken | query | string | No | |
AccessTokenSecret | query | string | No | |
Meta | query | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserId | form | string | No | |
SessionId | form | string | No | |
UserName | form | string | No | |
DisplayName | form | string | No | |
ReferrerUrl | form | string | No | |
BearerToken | form | string | No | |
RefreshToken | form | string | No | |
ResponseStatus | form | ResponseStatus | No | |
Meta | form | Dictionary<string, string> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /auth HTTP/1.1 Host: api.jiwa.com.au Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"UserId":"String","SessionId":"String","UserName":"String","DisplayName":"String","ReferrerUrl":"String","BearerToken":"String","RefreshToken":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Meta":{"String":"String"}}