...
...
...
...
...
...
...
...
...
...
| Tip |
|---|
TOTP API is supported by Ubisecure SSO as of version 8.6 |
...
TOTP API enables administrators to manage the TOTP secrets of the users. With TOTP API it's possible to manage the secrets for users in other types of directories in addition to Ubilogin Directory.
| Warning | ||
|---|---|---|
| ||
We do not recommend password.2 method users (External users) accessing TOTP API because enabling TOTP API for password.2 authentication method means, external users can access other user's data and can update their TOTP secrets data. |
The API calls available are:
- PUT /totp/api/v1/methods/{method} - Configures the TOTP method for a user
- DELETE /totp/api/v1/methods/{method} - Deletes the TOTP method from a user
- GET /totp/api/v1/methods/{method} - Gets the TOTP method status for a user
API documentation
TOTP API is documented using Swagger. In order to access the API specification, you can enable the API documentation as instructed in TOTP API configuration chapter Enable API documentation. Documentation is accessible in https://<sso-base-url>/totp/swagger-ui/ and it defines the endpoints, payloads, and responses. You can also use the Swagger UI to test the API.
...