Skip to main content
  • Bravura Security Fabric Documentation
  • API
  • REST API quick start

REST API quick start

This QuickStart guide will go through a simple example using the REST API. This is done using Swagger UI , which is included with Bravura Security Fabric .

Swagger UI is an interactive API documentation that allows users to execute REST API endpoints directly in the browser. By using Swagger UI, it will be easy to visualize what is being passed into the REST API and what is being returned. In addition, Swagger UI does not require any additional installation.

This example will involve a user changing their own account password and verifying that it has been changed. The workflow is as follows:

  1. A user logs into the REST API and gets an authentication (bearer) token

  2. The user calls an endpoint to get a list of their associated accounts

  3. The user calls an endpoint to get an account based on a key

  4. The user calls an endpoint to change the account’s password

  5. The user calls an endpoint to get the result of the password change

  6. The user calls an endpoint to test the account’s password

  7. The user calls an endpoint to get the result of the password test

  8. The user logs out of the REST API

By default, users can list their own accounts, and change and verify their own passwords, however users cannot view or act on other users’ accounts. This is enforced using Open Policy Agent authorization policy rules. Thus, some endpoints cannot be run unless additional permissions are granted. See our REST API Reference for more information.

In this section: