Inbound: Querying Cloudpath

You can retrieve information from Cloudpath through a REST-type API query and perform an action, based on the result data. For example, you might use an API query to block a user or revoke a certificate.

The API query, containing the identifier information and appropriate action, is sent to the server and the objects are returned in either JSON or XML.

The API call is structured as follows:

http://test.company.net/adm in/api/zAdBCLcgrwca/enrollment/IdentityCN/bob/get

  • http ://test.company.net/admin = HTTP authentication

  • api = API entry point

  • zAdBCLcgrwca = API key

  • enrollment = realm

  • IdentityCN = Identity type

  • bob = Identity value

  • get = Action

Each realm allows a different set of identity information. See the appropriate sections in API Examples for the list of valid identity types.