Webservice: Auth

authentication operations

Index		Method		Request(s)		Response		Description

1		valid		sid				checks if a SID is valid; returns true only if the session is valid

2		loginApiKey		apiKey				starts a new session; returns the session identifier(SID)

3		renew		sid				renews an existing session

4		login		username password				deprecated, use loginApiKey instead.

5		logout		sid				closes a session

Method #1: valid

checks if a SID is valid; returns true only if the session is valid

Request

Name		Type		Required		Multiple		Description

sid		String		Y				the session identifier

Response

Name		Type		Required		Multiple		Description

		Boolean		Y

Method #2: loginApiKey

starts a new session; returns the session identifier(SID)

Request

Name		Type		Required		Multiple		Description

apiKey		String		Y

Response

Name		Type		Required		Multiple		Description

		String		Y

Method #3: renew

renews an existing session

Request

Name		Type		Required		Multiple		Description

sid		String		Y				the session identifier

Method #4: login

deprecated, use loginApiKey instead.

Request

Name		Type		Required		Multiple		Description

username		String		Y

password		String		Y

Response

Name		Type		Required		Multiple		Description

		String		Y

Method #5: logout

closes a session

Request

Name		Type		Required		Multiple		Description

sid		String		Y				the session identifier