Tax Filing Service

<back to all web services

Authenticate

auth

Sign In

The following routes are available for this service:
GET,POST/auth/{provider}
GET,POST/auth
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 UserName { get; set; }

        [DataMember(Order=3)]
        public virtual string Password { get; set; }

        [DataMember(Order=4)]
        public virtual bool? RememberMe { get; set; }

        [DataMember(Order=5)]
        public virtual string AccessToken { get; set; }

        [DataMember(Order=6)]
        public virtual string AccessTokenSecret { get; set; }

        [DataMember(Order=7)]
        public virtual string ReturnUrl { get; set; }

        [DataMember(Order=8)]
        public virtual string ErrorView { get; set; }

        [DataMember(Order=9)]
        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 DateTime? RefreshTokenExpiry { get; set; }

        [DataMember(Order=9)]
        public virtual string ProfileUrl { get; set; }

        [DataMember(Order=10)]
        public virtual List<string> Roles { get; set; }

        [DataMember(Order=11)]
        public virtual List<string> Permissions { get; set; }

        [DataMember(Order=12)]
        public virtual ResponseStatus ResponseStatus { get; set; }

        [DataMember(Order=13)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

}

C# Authenticate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: taxfiling.pwc.de 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"provider":"String","userName":"String","password":"String","rememberMe":false,"accessToken":"String","accessTokenSecret":"String","returnUrl":"String","errorView":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"userId":"String","sessionId":"String","userName":"String","displayName":"String","referrerUrl":"String","bearerToken":"String","refreshToken":"String","refreshTokenExpiry":"\/Date(-62135596800000-0000)\/","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"}}