POST | /auth/{provider} | ||
---|---|---|---|
GET,POST | /auth |
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Sign In
*/
@Api(Description="Sign In")
@DataContract
open class Authenticate : IPost, IMeta
{
/**
* AuthProvider, e.g. credentials
*/
@DataMember(Order=1)
open var provider:String? = null
@DataMember(Order=2)
open var userName:String? = null
@DataMember(Order=3)
open var password:String? = null
@DataMember(Order=4)
open var rememberMe:Boolean? = null
@DataMember(Order=5)
open var accessToken:String? = null
@DataMember(Order=6)
open var accessTokenSecret:String? = null
@DataMember(Order=7)
open var returnUrl:String? = null
@DataMember(Order=8)
open var errorView:String? = null
@DataMember(Order=9)
open var meta:HashMap<String,String>? = null
}
@DataContract
open class AuthenticateResponse : IMeta, IHasSessionId, IHasBearerToken
{
@DataMember(Order=1)
open var userId:String? = null
@DataMember(Order=2)
open var sessionId:String? = null
@DataMember(Order=3)
open var userName:String? = null
@DataMember(Order=4)
open var displayName:String? = null
@DataMember(Order=5)
open var referrerUrl:String? = null
@DataMember(Order=6)
open var bearerToken:String? = null
@DataMember(Order=7)
open var refreshToken:String? = null
@DataMember(Order=8)
open var refreshTokenExpiry:Date? = null
@DataMember(Order=9)
open var profileUrl:String? = null
@DataMember(Order=10)
open var roles:ArrayList<String>? = null
@DataMember(Order=11)
open var permissions:ArrayList<String>? = null
@DataMember(Order=12)
open var authProvider:String? = null
@DataMember(Order=13)
open var responseStatus:ResponseStatus? = null
@DataMember(Order=14)
open var meta:HashMap<String,String>? = null
}
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/{provider} HTTP/1.1
Host: techstacks.io
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>
<UserName>String</UserName>
<Password>String</Password>
<RememberMe>false</RememberMe>
<AccessToken>String</AccessToken>
<AccessTokenSecret>String</AccessTokenSecret>
<ReturnUrl>String</ReturnUrl>
<ErrorView>String</ErrorView>
<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> <RefreshTokenExpiry>0001-01-01T00:00:00</RefreshTokenExpiry> <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> <AuthProvider>String</AuthProvider> <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>