Skip to main content

Setting up the Bravura Pass Remote API

The Bravura Pass remote API enables Phone Password Manager and other external applications to access Bravura Pass features such as user authentication and password change.

The Phone Password Manager server uses the following components to communicate with the API:

  • The Phone Password Manager service.

  • The Password Manager API Services (IDAPI and IDAPISOAP) on the Bravura Pass server.

  • The Bravura Pass API DLL (pspushpass.dll) installed on the Phone Password Manager server during setup.

In order to set up the Remote API on Bravura Pass server, you will need to:

See also

See more information about the API Service (idapi).

Enabling the API Service

The API Service and API SOAP Service must be running on Bravura Pass server before you can call the API. Both of these services are enabled and started by default, but unexpected shutdowns or maintenance may necessitate a manual restart.

To enable and start the API Service:

  1. Click Manage the system > Maintenance > Services.

  2. Select Bravura Security (idapi) API Service .

  3. Click Enable the service.

  4. Click Start the service.

  5. Select Bravura Security (idapisoap) API SOAP Service .

  6. Click Enable the service.

  7. Click Start the service.

Next:

Configure an IDAPI caller .

Configuring an API caller for Phone Password Manager

The API caller is an administrator account on the Bravura Pass instance which Phone Password Manager uses to implement API calls. The account _API_USER_TPM is included in a Bravura Pass installation, but is disabled by default.

You can designate any product administrator as the API caller by giving them the API caller privilege. You can also create a new product administrator.

To configure the API caller:

  1. Click Manage the system > Security > Access to product features.

  2. Configure _API_USER_TPM, or create a new product administrator, and grant it the API Caller privilege.

  3. Configure the IP address with CIDR bitmask to include the IP address of the Phone Password Manager server.

  4. Configure a password for the API caller, and click Update.

  5. Click Enable to activate the API caller account.

  6. If necessary, configure the Password Manager service (idpm ) .

Next:

Install the Phone Password Manager software.

See also

Bravura Security Fabric Remote API (api.pdf)

In this section: