Authentication
Authentication
Riversoft® STCP Gemini API authenticates the operators of the Riversoft Console Portal and of integrations. All methods end with a Bearer token, sent in the Authorization header of protected calls and invalidated at logout.
Choose the method
| Need | Method | Guide |
|---|---|---|
| Reproduce the Riversoft Console Portal sign-in, with 2FA | POST /oauth/v2/token | Local sign-in and 2FA |
| Sign in with a corporate directory account | LDAP in POST /oauth/v2/token | Sign-in with LDAP |
| Integrate systems with operator and password, without 2FA | Password grant in POST /oauth/token | Password grant |
| Sign in through the corporate provider in the browser | SSO (SAML 2.0 or OAuth 2.0) | Single Sign-On |
| Use the token and end the session | Authorization: Bearer header and DELETE /disconnect/api/v3/logout | Session and logout |
Note
POST /oauth/token and POST /oauth/v2/token receive the same form. Only the v2 route applies two-factor authentication (2FA) and accepts LDAP. With 2FA enabled, always use the v2 route.
In this section
Authenticate the operator at /oauth/v2/token, complete two-factor authentication and do the first TOTP registration.
Obtain the Bearer token at /oauth/token, for integrations with operator and password, without 2FA.
Federated sign-in and logout in the browser with SAML 2.0 and OAuth 2.0/OpenID Connect.
Send the token on protected routes, handle expiration and end the session.