POST | /auth/{provider} | ||
---|---|---|---|
GET,POST | /auth |
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Namespace Global
Namespace ServiceStack
'''<Summary>
'''Sign In
'''</Summary>
<Api(Description:="Sign In")>
<DataContract>
Public Partial Class Authenticate
Implements IPost
Implements IMeta
'''<Summary>
'''AuthProvider, e.g. credentials
'''</Summary>
<DataMember(Order:=1)>
Public Overridable Property provider As String
<DataMember(Order:=2)>
Public Overridable Property UserName As String
<DataMember(Order:=3)>
Public Overridable Property Password As String
<DataMember(Order:=4)>
Public Overridable Property RememberMe As Boolean?
<DataMember(Order:=5)>
Public Overridable Property AccessToken As String
<DataMember(Order:=6)>
Public Overridable Property AccessTokenSecret As String
<DataMember(Order:=7)>
Public Overridable Property ReturnUrl As String
<DataMember(Order:=8)>
Public Overridable Property ErrorView As String
<DataMember(Order:=9)>
Public Overridable Property Meta As Dictionary(Of String, String) Implements IMeta.Meta
End Class
<DataContract>
Public Partial Class AuthenticateResponse
Implements IMeta
Implements IHasSessionId
Implements IHasBearerToken
<DataMember(Order:=1)>
Public Overridable Property UserId As String
<DataMember(Order:=2)>
Public Overridable Property SessionId As String Implements IHasSessionId.SessionId
<DataMember(Order:=3)>
Public Overridable Property UserName As String
<DataMember(Order:=4)>
Public Overridable Property DisplayName As String
<DataMember(Order:=5)>
Public Overridable Property ReferrerUrl As String
<DataMember(Order:=6)>
Public Overridable Property BearerToken As String Implements IHasBearerToken.BearerToken
<DataMember(Order:=7)>
Public Overridable Property RefreshToken As String
<DataMember(Order:=8)>
Public Overridable Property RefreshTokenExpiry As Date?
<DataMember(Order:=9)>
Public Overridable Property ProfileUrl As String
<DataMember(Order:=10)>
Public Overridable Property Roles As List(Of String)
<DataMember(Order:=11)>
Public Overridable Property Permissions As List(Of String)
<DataMember(Order:=12)>
Public Overridable Property AuthProvider As String
<DataMember(Order:=13)>
Public Overridable Property ResponseStatus As ResponseStatus
<DataMember(Order:=14)>
Public Overridable Property Meta As Dictionary(Of String, String) Implements IMeta.Meta
End Class
End Namespace
End Namespace
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: techstacks.io
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 ], 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 } }