Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...


Tip

TOTP API is supported by Ubisecure SSO as of version 8.6

...

  • 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.

Tip
titleSwagger API specification

The API specification for your installation is available in https://<sso-base-url>/totp/v2v3/api-docs

Testing the API with the documentation webpage

...

In order to provide an access token to be used in the API calls, click the following button

and write Bearer followed by an the access token in the input field and click Authorize.

Image RemovedImage Added

After this you can try the different endpoints.

...