Webservice: Auth

authentication operations

Index Method Request(s) Response Description
1 logout sid
closes a session
2 login username
password
starts a new session; returns the session identifier(SID)
3 valid sid
checks if a SID is valid; returns true only if the session is valid
4 renew sid
renews an existing session

Method #1: logout

closes a session

Request

Name Type Required Multiple Description
     sid
String Y the session identifier

Method #2: login

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

Request

Name Type Required Multiple Description
     username
String Y
     password
String Y

Response

Name Type Required Multiple Description
    
String Y

Method #3: 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 #4: renew

renews an existing session

Request

Name Type Required Multiple Description
     sid
String Y the session identifier