| OPTIONS,GET,POST,DELETE | /auth | ||
|---|---|---|---|
| OPTIONS,GET,POST,DELETE | /auth/{provider} |
namespace ServiceStack
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract>]
[<AllowNullLiteral>]
type AuthenticateResponse() =
[<DataMember(Order=1)>]
member val UserId:String = null with get,set
[<DataMember(Order=2)>]
member val SessionId:String = null with get,set
[<DataMember(Order=3)>]
member val UserName:String = null with get,set
[<DataMember(Order=4)>]
member val DisplayName:String = null with get,set
[<DataMember(Order=5)>]
member val ReferrerUrl:String = null with get,set
[<DataMember(Order=6)>]
member val BearerToken:String = null with get,set
[<DataMember(Order=7)>]
member val RefreshToken:String = null with get,set
[<DataMember(Order=8)>]
member val ProfileUrl:String = null with get,set
[<DataMember(Order=9)>]
member val Roles:ResizeArray<String> = new ResizeArray<String>() with get,set
[<DataMember(Order=10)>]
member val Permissions:ResizeArray<String> = new ResizeArray<String>() with get,set
[<DataMember(Order=11)>]
member val ResponseStatus:ResponseStatus = null with get,set
[<DataMember(Order=12)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
///<summary>
///Sign In
///</summary>
[<Api(Description="Sign In")>]
[<DataContract>]
[<AllowNullLiteral>]
type Authenticate() =
interface IPost
///<summary>
///AuthProvider, e.g. credentials
///</summary>
[<DataMember(Order=1)>]
member val provider:String = null with get,set
[<DataMember(Order=2)>]
member val State:String = null with get,set
[<DataMember(Order=3)>]
member val oauth_token:String = null with get,set
[<DataMember(Order=4)>]
member val oauth_verifier:String = null with get,set
[<DataMember(Order=5)>]
member val UserName:String = null with get,set
[<DataMember(Order=6)>]
member val Password:String = null with get,set
[<DataMember(Order=7)>]
member val RememberMe:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<DataMember(Order=9)>]
member val ErrorView:String = null with get,set
[<DataMember(Order=10)>]
member val nonce:String = null with get,set
[<DataMember(Order=11)>]
member val uri:String = null with get,set
[<DataMember(Order=12)>]
member val response:String = null with get,set
[<DataMember(Order=13)>]
member val qop:String = null with get,set
[<DataMember(Order=14)>]
member val nc:String = null with get,set
[<DataMember(Order=15)>]
member val cnonce:String = null with get,set
[<DataMember(Order=17)>]
member val AccessToken:String = null with get,set
[<DataMember(Order=18)>]
member val AccessTokenSecret:String = null with get,set
[<DataMember(Order=19)>]
member val scope:String = null with get,set
[<DataMember(Order=20)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
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.
POST /auth HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
provider: String,
state: String,
oauth_token: String,
oauth_verifier: String,
userName: String,
password: String,
rememberMe: False,
errorView: String,
nonce: String,
uri: String,
response: String,
qop: String,
nc: String,
cnonce: String,
accessToken: String,
accessTokenSecret: String,
scope: String,
meta:
{
String: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
userId: String,
sessionId: String,
userName: String,
displayName: String,
referrerUrl: String,
bearerToken: String,
refreshToken: String,
profileUrl: String,
roles:
[
String
],
permissions:
[
String
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
meta:
{
String: String
}
}