GET,POST | /auth/{provider} | ||
---|---|---|---|
GET,POST | /auth |
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 RefreshTokenExpiry:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=9)>]
member val ProfileUrl:String = null with get,set
[<DataMember(Order=10)>]
member val Roles:ResizeArray<String> = new ResizeArray<String>() with get,set
[<DataMember(Order=11)>]
member val Permissions:ResizeArray<String> = new ResizeArray<String>() with get,set
[<DataMember(Order=12)>]
member val ResponseStatus:ResponseStatus = null with get,set
[<DataMember(Order=13)>]
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 UserName:String = null with get,set
[<DataMember(Order=3)>]
member val Password:String = null with get,set
[<DataMember(Order=4)>]
member val RememberMe:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<DataMember(Order=5)>]
member val AccessToken:String = null with get,set
[<DataMember(Order=6)>]
member val AccessTokenSecret:String = null with get,set
[<DataMember(Order=7)>]
member val ReturnUrl:String = null with get,set
[<DataMember(Order=8)>]
member val ErrorView:String = null with get,set
[<DataMember(Order=9)>]
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/{provider} HTTP/1.1
Host: initiation.sirva.com
Accept: text/jsv
Content-Type: text/jsv
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: text/jsv Content-Length: length { UserId: String, SessionId: String, UserName: String, DisplayName: String, ReferrerUrl: String, BearerToken: String, RefreshToken: String, RefreshTokenExpiry: 0001-01-01, 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 } }