OPTIONS,GET,POST,DELETE | /auth | ||
---|---|---|---|
OPTIONS,GET,POST,DELETE | /auth/{provider} |
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
namespace ServiceStack
{
///<summary>
///Sign In
///</summary>
[Api(Description="Sign In")]
[DataContract]
public partial class Authenticate
: IPost, IMeta
{
public Authenticate()
{
Meta = new Dictionary<string, string>{};
}
///<summary>
///AuthProvider, e.g. credentials
///</summary>
[DataMember(Order=1)]
public virtual string provider { get; set; }
[DataMember(Order=2)]
public virtual string State { get; set; }
[DataMember(Order=3)]
public virtual string oauth_token { get; set; }
[DataMember(Order=4)]
public virtual string oauth_verifier { get; set; }
[DataMember(Order=5)]
public virtual string UserName { get; set; }
[DataMember(Order=6)]
public virtual string Password { get; set; }
[DataMember(Order=7)]
public virtual bool? RememberMe { get; set; }
[DataMember(Order=9)]
public virtual string ErrorView { get; set; }
[DataMember(Order=10)]
public virtual string nonce { get; set; }
[DataMember(Order=11)]
public virtual string uri { get; set; }
[DataMember(Order=12)]
public virtual string response { get; set; }
[DataMember(Order=13)]
public virtual string qop { get; set; }
[DataMember(Order=14)]
public virtual string nc { get; set; }
[DataMember(Order=15)]
public virtual string cnonce { get; set; }
[DataMember(Order=17)]
public virtual string AccessToken { get; set; }
[DataMember(Order=18)]
public virtual string AccessTokenSecret { get; set; }
[DataMember(Order=19)]
public virtual string scope { get; set; }
[DataMember(Order=20)]
public virtual Dictionary<string, string> Meta { get; set; }
}
[DataContract]
public partial class AuthenticateResponse
: IMeta, IHasSessionId, IHasBearerToken
{
public AuthenticateResponse()
{
Roles = new List<string>{};
Permissions = new List<string>{};
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual string UserId { get; set; }
[DataMember(Order=2)]
public virtual string SessionId { get; set; }
[DataMember(Order=3)]
public virtual string UserName { get; set; }
[DataMember(Order=4)]
public virtual string DisplayName { get; set; }
[DataMember(Order=5)]
public virtual string ReferrerUrl { get; set; }
[DataMember(Order=6)]
public virtual string BearerToken { get; set; }
[DataMember(Order=7)]
public virtual string RefreshToken { get; set; }
[DataMember(Order=8)]
public virtual string ProfileUrl { get; set; }
[DataMember(Order=9)]
public virtual List<string> Roles { get; set; }
[DataMember(Order=10)]
public virtual List<string> Permissions { get; set; }
[DataMember(Order=11)]
public virtual ResponseStatus ResponseStatus { get; set; }
[DataMember(Order=12)]
public virtual Dictionary<string, string> Meta { get; set; }
}
}
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-12.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>