API SOAP Service (idapisoap)

The API SOAP Service has a couple of methods of exchanging metadata. When using the default httpget, the metadata exchange URL is:

service_endpoint/wsdl

For example:

https://<IP or fqdn>/INST/idapi2/wsdl

If the API SOAP Service uses MexHttpGet, the URL is:

https://<IP or fqdn>/INST/idapi2/metadata/wsdl

If the API SOAP Service uses wsHttpBinding, then Mex metadata exchange can be used, and the metadata exchange URL is same as service endpoint.

Changes to the service are not effective until the service is restarted.

If the end point is secured with SSL (https), then the binding for IIS is used to map the certificate to the secure endpoint.

This example demonstrates how to create a product administrator with the IDAPI caller privilege and configure the Bravura Security API SOAP service for external API access. This setup allows a third-party application to communicate with Bravura Security Fabric .

With this configuration, a third party application can be configured to use the administrator account and the configured API SOAP service to communicate with Bravura Security Fabric .

For example, a ticket is raised in ServiceNow for a new employee. ServiceNow communicates with Bravura Security Fabric to submit a request for an account creation in Bravura Security Fabric .

Create a user with the IDAPI caller privilege

To create the user:

Set up the Bravura Security API SOAP service

This step specifically assist with the IIS binding that is needed for the service to run. For more detailed information about the API SOAP Service, see API SOAP Service .

Sample script in Python

This following script is an example of an API call to display the known attributes for a specific profile to ensure you have a successful connection and can list data.

from zeep import Client
from zeep.helpers import serialize_object
# Update with appropriate URL
wsdl = 'http://localhost/test/idapi/wsdl'
# Update with appropriate API user that you created
api_user = 'API_TEST_USER'
# Update with appropriate password that you set
api_pass = 'SomethingRandom123456!'
# Update with appropriate profileID from your system
profile = '100005'
class ApiError(Exception):
  pass
def assert_api_op(ret, op=None):
  if ret.rc != 0 and ret.rc != 1:
    if op:
      raise ApiError('{} Error#{}: {}'.format(op, ret.rc, ret.errmsg))
    else:
      raise ApiError('Error #{}: {}'.format(ret.rc, ret.errmsg))
  return ret.sessdat
client = Client(wsdl)
LoginRequest = {
  'userid': api_user,
  'password': api_pass,
  'isadmin': 1,
  'options': '',
  'sessdat': ''
}
LoginResponse = client.service.Login(LoginRequest)
sess = assert_api_op(LoginResponse, 'Login')
UserStatusGetResponse = client.service.UserStatusGet(
  {'userid': profile, 'sessdat': sess})
sess = assert_api_op(UserStatusGetResponse, 'UserStatusGet')
UserStatus = serialize_object(
  UserStatusGetResponse.output.UserStatusGet_vectorOutput[0])
print("      Profile: {}".format(profile))
for k,v in UserStatus.items():
  print("{:>18}: {}".format(k, v))