Authentication and authorization - BlueCat Address Manager - 8.3.0

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
8.3.0

Address Manager uses a token-based authentication and authorization. Once generated, the token must be used when invoking every subsequent API method in Address Manager.

Generating a token

You need to generate the authentication and authorization token by invoking the login API method. You must use an API user account to access the Address Manager API. If the credentials are invalid, it will fail with an error. For more information about log in and log out methods, refer to Log in and Log out.

Log in format:
http://<AddressManager_IP or hostname>/Services/REST/v1/login?username=<username>&password=<password>

Output / Response

The body of the JSON response for the above API method will be in the "Session Token-> ${ACTUAL_TOKEN} <- for User : ${USERNAME_PASSED}" and it can be used to extract the authorization token.

The ACTUAL_TOKEN is comprised of the keyword BAMAuthToken and a dynamically generated token hash. For example, “BAMAuthToken: 4bippMTQ1ODAzNzgwNjE0MzphcGk=”.

Authorizing API methods

The generated authorization token must be passed when invoking any API method. The token needs to be passed as an Authorization property in the request header.

Configuring the token timeout

By default, the generated token expires after 5 minutes. You can change this behavior according to your use case.
Note: For details on how to change the token timeout, refer to knowledge base article 7724 on BlueCat Customer Care.