TechStacks!

<back to all web services

Authenticate

auth

Sign In

The following routes are available for this service:
POST/auth/{provider}
GET,POST/auth
Authenticate Parameters:
NameParameterData TypeRequiredDescription
providerpathstringNoAuthProvider, e.g. credentials
UserNamebodystringNo
PasswordbodystringNo
RememberMebodybool?No
AccessTokenbodystringNo
AccessTokenSecretbodystringNo
ReturnUrlbodystringNo
ErrorViewbodystringNo
MetabodyDictionary<string, string>No
AuthenticateResponse Parameters:
NameParameterData TypeRequiredDescription
UserIdformstringNo
SessionIdformstringNo
UserNameformstringNo
DisplayNameformstringNo
ReferrerUrlformstringNo
BearerTokenformstringNo
RefreshTokenformstringNo
RefreshTokenExpiryformDateTime?No
ProfileUrlformstringNo
RolesformList<string>No
PermissionsformList<string>No
ResponseStatusformResponseStatusNo
MetaformDictionary<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: techstacks.io 
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
	}
}