Platform Subscription API

Authenticate

auth

Sign In

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

Kotlin 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 /api/auth/{provider} HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length

{
	UserId: String,
	SessionId: String,
	UserName: String,
	DisplayName: String,
	ReferrerUrl: String,
	BearerToken: String,
	RefreshToken: String,
	RefreshTokenExpiry: 0001-01-01,
	ProfileUrl: String,
	Roles: 
	[
		String
	],
	Permissions: 
	[
		String
	],
	AuthProvider: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Meta: 
	{
		String: String
	}
}