Get Global Catalog connectivity details
This method returns the Global Catalog connectivity details as set for the PTA Administration. To run this method, you must be a member of the Vault Admins or Security Admins group.
URL
-
Make sure there are no spaces in the URL.
-
The following characters are not supported in URL values: + & %
-
If the URL includes a dot (.), add a forward slash (/) at the end of the URL. For example: api/Safes/MySafe/Members/user@cyber.com/
|
Resource information
HTTP method |
GET |
Content type |
application/json |
Header parameter
Parameter |
Description |
---|---|
Authorization (mandatory) |
The token that identifies the session, encoded in BASE 64. Type: string |
Result
|
Parameter |
Description |
---|---|
ldap_server |
The Global Catalog server address in FQDN format. Type: string |
ldap_port |
The server port number of the Global Catalog. The default Global Catalog ports are 3268 (LDAP) and 3269 (LDAPS). Type: number |
upn |
The User Principle Name of the Active Directory bind user that will be used to connect and query the Global Catalog. Type: string |
ldap_password |
The credentials of the Active Directory bind user that will be used to connect and query the Global Catalog. Always returned as null. Type: string |
account_id |
The ID of the vaulted Domain Account bind user that will be used to connect and query the Global Catalog. Returned as null when upn is configured. Type: string |
ssl |
Whether a secure connection is used when connecting to Global Catalog. Type: boolean |
Return codes
For a complete list of return codes, see Return Codes.