| GET,POST | /auth/{provider} | ||
|---|---|---|---|
| GET,POST | /auth/{provider} | ||
| GET,POST | /auth | ||
| GET,POST | /auth |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| provider | path | string | No | AuthProvider, e.g. credentials |
| UserName | body | string | No | |
| Password | body | string | No | |
| RememberMe | body | bool? | No | |
| AccessToken | body | string | No | |
| AccessTokenSecret | body | string | No | |
| ReturnUrl | body | string | No | |
| ErrorView | body | string | No | |
| Meta | body | 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 | |
| RefreshTokenExpiry | form | DateTime? | No | |
| ProfileUrl | form | string | No | |
| Roles | form | List<string> | No | |
| Permissions | form | List<string> | No | |
| AuthProvider | 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.
POST /auth/{provider} HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"provider":"String","UserName":"String","Password":"String","RememberMe":false,"AccessToken":"String","AccessTokenSecret":"String","ReturnUrl":"String","ErrorView":"String","Meta":{"String":"String"}}
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","RefreshTokenExpiry":"0001-01-01T00:00:00.0000000","ProfileUrl":"String","Roles":["String"],"Permissions":["String"],"AuthProvider":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Meta":{"String":"String"}}