GET,POST | /auth/{provider} | ||
---|---|---|---|
GET,POST | /auth |
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
namespace ServiceStack
{
///<summary>
///Sign In
///</summary>
[Api(Description="Sign In")]
[DataContract]
public partial class Authenticate
: IPost, IMeta
{
public Authenticate()
{
Meta = new Dictionary<string, string>{};
}
///<summary>
///AuthProvider, e.g. credentials
///</summary>
[DataMember(Order=1)]
public virtual string provider { get; set; }
[DataMember(Order=2)]
public virtual string UserName { get; set; }
[DataMember(Order=3)]
public virtual string Password { get; set; }
[DataMember(Order=4)]
public virtual bool? RememberMe { get; set; }
[DataMember(Order=5)]
public virtual string AccessToken { get; set; }
[DataMember(Order=6)]
public virtual string AccessTokenSecret { get; set; }
[DataMember(Order=7)]
public virtual string ReturnUrl { get; set; }
[DataMember(Order=8)]
public virtual string ErrorView { get; set; }
[DataMember(Order=9)]
public virtual Dictionary<string, string> Meta { get; set; }
}
[DataContract]
public partial class AuthenticateResponse
: IMeta, IHasSessionId, IHasBearerToken
{
public AuthenticateResponse()
{
Roles = new List<string>{};
Permissions = new List<string>{};
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual string UserId { get; set; }
[DataMember(Order=2)]
public virtual string SessionId { get; set; }
[DataMember(Order=3)]
public virtual string UserName { get; set; }
[DataMember(Order=4)]
public virtual string DisplayName { get; set; }
[DataMember(Order=5)]
public virtual string ReferrerUrl { get; set; }
[DataMember(Order=6)]
public virtual string BearerToken { get; set; }
[DataMember(Order=7)]
public virtual string RefreshToken { get; set; }
[DataMember(Order=8)]
public virtual DateTime? RefreshTokenExpiry { get; set; }
[DataMember(Order=9)]
public virtual string ProfileUrl { get; set; }
[DataMember(Order=10)]
public virtual List<string> Roles { get; set; }
[DataMember(Order=11)]
public virtual List<string> Permissions { get; set; }
[DataMember(Order=12)]
public virtual ResponseStatus ResponseStatus { get; set; }
[DataMember(Order=13)]
public virtual Dictionary<string, string> Meta { 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 } }