MicroApp API

Authenticate

auth

Sign In

The following routes are available for this service:
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; }
    }

}

C# Authenticate DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	provider: String,
	state: String,
	oauth_token: String,
	oauth_verifier: String,
	userName: String,
	password: String,
	rememberMe: False,
	errorView: String,
	nonce: String,
	uri: String,
	response: String,
	qop: String,
	nc: String,
	cnonce: String,
	accessToken: String,
	accessTokenSecret: String,
	scope: String,
	meta: 
	{
		String: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	userId: String,
	sessionId: String,
	userName: String,
	displayName: String,
	referrerUrl: String,
	bearerToken: String,
	refreshToken: String,
	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
	}
}