All URIs are relative to https://localhost:5000/v1/api
Method | HTTP request | Description |
---|---|---|
iserver_auth_status_post | post /iserver/auth/status | Authentication Status |
iserver_reauthenticate_post | post /iserver/reauthenticate | Tries to re-authenticate to Brokerage |
logout_post | post /logout | Ends the current session |
sso_validate_get | get /sso/validate | Validate SSO |
tickle_post | post /tickle | Ping the server to keep the session open |
crate::models::AuthStatus iserver_auth_status_post() Authentication Status
Current Authentication status to the Brokerage system. Market Data and Trading is not possible if not authenticated, e.g. authenticated shows false
This endpoint does not need any parameter.
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::AuthStatus iserver_reauthenticate_post() Tries to re-authenticate to Brokerage
When using the CP Gateway, this endpoint provides a way to reauthenticate to the Brokerage system as long as there is a valid SSO session, see /sso/validate.
This endpoint does not need any parameter.
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::InlineResponse200 logout_post() Ends the current session
Logs the user out of the gateway session. Any further activity requires re-authentication.
This endpoint does not need any parameter.
crate::models::InlineResponse200
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::InlineResponse20032 sso_validate_get() Validate SSO
Validates the current session for the SSO user
This endpoint does not need any parameter.
crate::models::InlineResponse20032
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
tickle_post() Ping the server to keep the session open
If the gateway has not received any requests for several minutes an open session will automatically timeout. The tickle endpoint pings the server to prevent the session from ending.
This endpoint does not need any parameter.
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]