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 .xml suffix or ?format=xml
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-11.tclclouds.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<Authenticate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<provider>String</provider>
<State>String</State>
<oauth_token>String</oauth_token>
<oauth_verifier>String</oauth_verifier>
<UserName>String</UserName>
<Password>String</Password>
<RememberMe>false</RememberMe>
<ErrorView>String</ErrorView>
<nonce>String</nonce>
<uri>String</uri>
<response>String</response>
<qop>String</qop>
<nc>String</nc>
<cnonce>String</cnonce>
<AccessToken>String</AccessToken>
<AccessTokenSecret>String</AccessTokenSecret>
<scope>String</scope>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
</Authenticate>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <AuthenticateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <UserId>String</UserId> <SessionId>String</SessionId> <UserName>String</UserName> <DisplayName>String</DisplayName> <ReferrerUrl>String</ReferrerUrl> <BearerToken>String</BearerToken> <RefreshToken>String</RefreshToken> <ProfileUrl>String</ProfileUrl> <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>String</d2p1:string> </Roles> <Permissions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>String</d2p1:string> </Permissions> <ResponseStatus> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> </ResponseStatus> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> </AuthenticateResponse>