TeleportService

<back to all web services

Authenticate

The following routes are available for this service:
All Verbs/auth
All Verbs/auth/{provider}
Authenticate Parameters:
NameParameterData TypeRequiredDescription
providerpathstringNo
StatequerystringNo
oauth_tokenquerystringNo
oauth_verifierquerystringNo
UserNamequerystringNo
PasswordquerystringNo
RememberMequerybool?No
ErrorViewquerystringNo
noncequerystringNo
uriquerystringNo
responsequerystringNo
qopquerystringNo
ncquerystringNo
cnoncequerystringNo
UseTokenCookiequerybool?No
AccessTokenquerystringNo
AccessTokenSecretquerystringNo
scopequerystringNo
MetaqueryDictionary<string, string>No
AuthenticateResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
UserIdformstringNo
SessionIdformstringNo
UserNameformstringNo
DisplayNameformstringNo
ReferrerUrlformstringNo
BearerTokenformstringNo
RefreshTokenformstringNo
ProfileUrlformstringNo
RolesformList<string>No
PermissionsformList<string>No
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 HTTP/1.1 
Host: wbs.e-teleport.ru 
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,
	UseTokenCookie: False,
	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
	}
}