Appendix

Migration From v1 or v2

Any script or application written for v1 or v2 of the API needs some minor modifications to work with v3, namely the Authorization header and URL endpoints.

Authorization Header

In v1 and v2, the authorization header was used solely for the API application key. Now it is used to communicate the API application key as well as the RunAs username.

HttpClient client = new HttpClient();

client.DefaultRequestHeaders.Add("Authorization", "PS-Auth key=C9AB26FB-B322- ED97-A34C-215CA4D9630C; runas=doe-main\johndoe;");

$headers = @{ Authorization="PS-Auth key=C9AB26FB-B322-ED97-A34C-215CA4D9630C; runas=doe-main\johndoe;"; };

Endpoint Comparison

Note the use of https/SSL and removal of PasswordSafe segment in v3:

• v1 base endpoint: http://the-server/BeyondTrust/api/public/v1/PasswordSafe
• v2 base endpoint: http://the-server/BeyondTrust/api/public/v2/PasswordSafe
• v3 base endpoint: https://the-server/BeyondTrust/api/public/v3

Endpoint Mapping

Migration from v1

Migration from v2