OPTIONS,GET,POST,DELETE | /auth | ||
---|---|---|---|
OPTIONS,GET,POST,DELETE | /auth/{provider} |
Imports System
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
Public Sub New()
Meta = New Dictionary(Of String, String)
End Sub
'''<Summary>
'''AuthProvider, e.g. credentials
'''</Summary>
<DataMember(Order:=1)>
Public Overridable Property provider As String
<DataMember(Order:=2)>
Public Overridable Property State As String
<DataMember(Order:=3)>
Public Overridable Property oauth_token As String
<DataMember(Order:=4)>
Public Overridable Property oauth_verifier As String
<DataMember(Order:=5)>
Public Overridable Property UserName As String
<DataMember(Order:=6)>
Public Overridable Property Password As String
<DataMember(Order:=7)>
Public Overridable Property RememberMe As Nullable(Of Boolean)
<DataMember(Order:=9)>
Public Overridable Property ErrorView As String
<DataMember(Order:=10)>
Public Overridable Property nonce As String
<DataMember(Order:=11)>
Public Overridable Property uri As String
<DataMember(Order:=12)>
Public Overridable Property response As String
<DataMember(Order:=13)>
Public Overridable Property qop As String
<DataMember(Order:=14)>
Public Overridable Property nc As String
<DataMember(Order:=15)>
Public Overridable Property cnonce As String
<DataMember(Order:=17)>
Public Overridable Property AccessToken As String
<DataMember(Order:=18)>
Public Overridable Property AccessTokenSecret As String
<DataMember(Order:=19)>
Public Overridable Property scope As String
<DataMember(Order:=20)>
Public Overridable Property Meta As Dictionary(Of String, String)
End Class
<DataContract>
Public Partial Class AuthenticateResponse
Implements IMeta
Implements IHasSessionId
Implements IHasBearerToken
Public Sub New()
Roles = New List(Of String)
Permissions = New List(Of String)
Meta = New Dictionary(Of String, String)
End Sub
<DataMember(Order:=1)>
Public Overridable Property UserId As String
<DataMember(Order:=2)>
Public Overridable Property SessionId As String
<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
<DataMember(Order:=7)>
Public Overridable Property RefreshToken As String
<DataMember(Order:=8)>
Public Overridable Property ProfileUrl As String
<DataMember(Order:=9)>
Public Overridable Property Roles As List(Of String)
<DataMember(Order:=10)>
Public Overridable Property Permissions As List(Of String)
<DataMember(Order:=11)>
Public Overridable Property ResponseStatus As ResponseStatus
<DataMember(Order:=12)>
Public Overridable Property Meta As Dictionary(Of String, String)
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 HTTP/1.1
Host: appcenter.tclclouds.com
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 } }