Home Server browser API Documentation Jedox OLAP Home

Jedox OLAP documentation

home > API > [/server/login] >

request url

https://[SERVER]:[PORT]/server/login[?PARAMETER1=value[&...]]

short description

This request is used for user authentication and to get session identifiers (sid).

long description

The session identifier (sid) is used to identify a connection to the palo server. Therefore the session identifier has to be appended to each request (except /server/login and /server/info request).
If no request is made using a session identifier for some time, the session will timeout and becomes invalid. A new session identifier has to be requested in this case.

parameters

name	type	description
user	string	The name of the user (required if require-user is enabled)
password	string	Obsolote. Use the extern_password parameter.
extern_password	string	The plain text password of the user (required if require-user is enabled and the supervision server is used for authentication or authorization)
type	integer	When 1 server only tries the login validity without creating session. When 2 (SVS mode) it check internal authentication only.
machine	string	Optional parameter. Machine identifier.
required	string	Optional parameter. List of required features.
optional	string	Optional parameter. List of optional features.
new_name	string	Optional parameter. Name of the session. Displayed in management console.
external_identifier	string	Optional parameter. User's locale. Used for subset sorting.
mode	integer	Time in seconds remaining to license expiration

result

#	name	type	description
0	sid	string	Session identifier for a server connection.
1	ttl	string	Timeout interval in seconds. If no request is made within this interval the session becomes inactive.
2	optional	string	List of optional features server has licenses for.
3	enabled_gpu	boolean	1 if gpu engine is enabled, otherwise 0.

examples

description

further information