| 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 | login |
username password |
deprecated, use loginApiKey instead. | |||||
| 4 | logout |
sid |
closes a session | |||||
| 5 | renew |
sid |
renews an existing session |
checks if a SID is valid; returns true only if the session is valid
| Name | Type | Required | Multiple | Description | ||||
|---|---|---|---|---|---|---|---|---|
|
sid
|
String | Y | the session identifier |
| Name | Type | Required | Multiple | Description | ||||
|---|---|---|---|---|---|---|---|---|
|
|
Boolean | Y |
starts a new session; returns the session identifier(SID)
| Name | Type | Required | Multiple | Description | ||||
|---|---|---|---|---|---|---|---|---|
|
apiKey
|
String | Y |
| Name | Type | Required | Multiple | Description | ||||
|---|---|---|---|---|---|---|---|---|
|
|
String | Y |
deprecated, use loginApiKey instead.
| Name | Type | Required | Multiple | Description | ||||
|---|---|---|---|---|---|---|---|---|
|
username
|
String | Y | ||||||
|
password
|
String | Y |
| Name | Type | Required | Multiple | Description | ||||
|---|---|---|---|---|---|---|---|---|
|
|
String | Y |
closes a session
| Name | Type | Required | Multiple | Description | ||||
|---|---|---|---|---|---|---|---|---|
|
sid
|
String | Y | the session identifier |
renews an existing session
| Name | Type | Required | Multiple | Description | ||||
|---|---|---|---|---|---|---|---|---|
|
sid
|
String | Y | the session identifier |