OPTIONS,GET,POST,DELETE | /auth | ||
---|---|---|---|
OPTIONS,GET,POST,DELETE | /auth/{provider} |
import Foundation
import ServiceStack
/**
* Sign In
*/
// @Api(Description="Sign In")
// @DataContract
public class Authenticate : IPost, IMeta, Codable
{
/**
* AuthProvider, e.g. credentials
*/
// @DataMember(Order=1)
public var provider:String
// @DataMember(Order=2)
public var state:String
// @DataMember(Order=3)
public var oauth_token:String
// @DataMember(Order=4)
public var oauth_verifier:String
// @DataMember(Order=5)
public var userName:String
// @DataMember(Order=6)
public var password:String
// @DataMember(Order=7)
public var rememberMe:Bool?
// @DataMember(Order=9)
public var errorView:String
// @DataMember(Order=10)
public var nonce:String
// @DataMember(Order=11)
public var uri:String
// @DataMember(Order=12)
public var response:String
// @DataMember(Order=13)
public var qop:String
// @DataMember(Order=14)
public var nc:String
// @DataMember(Order=15)
public var cnonce:String
// @DataMember(Order=17)
public var accessToken:String
// @DataMember(Order=18)
public var accessTokenSecret:String
// @DataMember(Order=19)
public var scope:String
// @DataMember(Order=20)
public var meta:[String:String] = [:]
required public init(){}
}
// @DataContract
public class AuthenticateResponse : IMeta, IHasSessionId, IHasBearerToken, Codable
{
// @DataMember(Order=1)
public var userId:String
// @DataMember(Order=2)
public var sessionId:String
// @DataMember(Order=3)
public var userName:String
// @DataMember(Order=4)
public var displayName:String
// @DataMember(Order=5)
public var referrerUrl:String
// @DataMember(Order=6)
public var bearerToken:String
// @DataMember(Order=7)
public var refreshToken:String
// @DataMember(Order=8)
public var profileUrl:String
// @DataMember(Order=9)
public var roles:[String] = []
// @DataMember(Order=10)
public var permissions:[String] = []
// @DataMember(Order=11)
public var responseStatus:ResponseStatus
// @DataMember(Order=12)
public var meta:[String:String] = [:]
required public init(){}
}
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: apps.harbourassist.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>