MyApp

Authenticate

auth

Sign In

The following routes are available for this service:
GET,POST	/auth/{provider}
GET,POST	/auth

**Authenticate** Parameters:
Name	Parameter	Data Type	Required	Description
provider	path	string	No	AuthProvider, e.g. credentials
UserName	body	string	No
Password	body	string	No
RememberMe	body	bool?	No
AccessToken	body	string	No
AccessTokenSecret	body	string	No
ReturnUrl	body	string	No
ErrorView	body	string	No
Meta	body	Dictionary<string, string>	No

**AuthenticateResponse** Parameters:
Name	Parameter	Data Type	Required
UserId	form	string	No
SessionId	form	string	No
UserName	form	string	No
DisplayName	form	string	No
ReferrerUrl	form	string	No
BearerToken	form	string	No
RefreshToken	form	string	No
RefreshTokenExpiry	form	DateTime?	No
ProfileUrl	form	string	No
Roles	form	List<string>	No
Permissions	form	List<string>	No
ResponseStatus	form	ResponseStatus	No
Meta	form	Dictionary<string, string>	No

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/{provider} HTTP/1.1 
Host: vue-vite-api.jamstacks.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
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	meta: 
	{
		String: String
	}
}