ID Manager API Example

  • 1
  • Question
  • Updated 3 years ago
  • Answered
  • (Edited)
I'm wondering if anyone has created a working query to the new ID Manager APIs.  I've been sent a document about them by our territory rep but its missing a fair amount of information.  I'm also not sure the IDM version we're assigned to (6.1r1) has the API interface exposed, or if I'm even querying the proper URL.  Right now my queries just return a complete HTML login page instead of JSON data.

If someone has a working example, or if I can make one myself, I'll make sure to post it here so that everyone who's been waiting for an API can use it.
Photo of Alan Price

Alan Price

  • 5 Posts
  • 0 Reply Likes

Posted 4 years ago

  • 1
Photo of John Hanay

John Hanay

  • 38 Posts
  • 8 Reply Likes
The APIs are active in the production release of ID Manager. You need to turn on API access and generate a token for the APIs to function.  This is performed in the ID Manager Settings > API Integration.

The documentation will be released in a few weeks.
(Edited)
Photo of Alan Price

Alan Price

  • 5 Posts
  • 0 Reply Likes
Hi John.
That would be the guide.  I already enabled the API and retrieved our token, but the one thing missing from the guide is how exactly to query.  I says I need a token, username, and password but it doesn't say how to specify them (that is, the names of those header fields or how to build an authentication string like HiveManager APIs use).  I'm happy to be a guinea pig as Aerohive will allow.  We have some internal project deadlines I'd like to meet but if that won't be possible until the docs are complete then they'll have to wait.
Photo of Robert Nicholas

Robert Nicholas, Employee

  • 7 Posts
  • 6 Reply Likes
Hi, Alan--

The document only contains the bits (of the document, not the API) that are completed to this point, so there are great swaths of information still missing. Once those missing bits are completed and included, the document will be much more lucid and helpful. Sorry that you're having that experience, though.

If you (or anyone for that matter) have questions about initial setup conditions, version compatibility, or anything else, please feel free to include them here in this thread so that we can make certain they are addressed in the final document.
Photo of pwinward@jade-solutions.co.uk

pwinward@jade-solutions.co.uk

  • 1 Post
  • 0 Reply Likes
I too would like to know how to drag the data out of hive manager so i can use it for other things.
Is this even possible? Seems like i am going in circles with aerohive at the moment.
Photo of Alan Price

Alan Price

  • 5 Posts
  • 0 Reply Likes
For anyone watching this thread it looks like the API documentation has been released.  You'll find it in the ID Manager help webpages at the very bottom, in the footer.  As of right now the direct link is http://www.aerohive.com/330000/docs/help/english/documentation/ID-Manager-REST-API-Configuration-Gui....

I'll post back if I get a working example running.
Photo of John Hanay

John Hanay

  • 38 Posts
  • 8 Reply Likes
FYI...we are adding another API call (April release) so you can query for all the credentials created by an ID Manager user. We'll also be updating the ID Manager for iOS app to use this API for the Previous Keys feature to support multi-device use.

In addition, we are developing an HTML5 app that focuses on the Personal Use workflow and will post that source once the project is completed (late April).
Photo of Alan Price

Alan Price

  • 5 Posts
  • 0 Reply Likes
Very cool.  I'll be watching for those.
(Edited)
Photo of John Hanay

John Hanay

  • 38 Posts
  • 8 Reply Likes
Don't know if you are having issues with the APIs but a few things to consider are:
-  Need to enable the API Integration in ID Manager
-  APIs calls are case sensitive 
-  You can authenticate using a ID Manager admin user
Photo of Roberto Casula

Roberto Casula, Champ

  • 231 Posts
  • 111 Reply Likes
Also, you need to ensure that your requests include both a "content-type" and "accept" header specifying "application/json". Also, there is a Firefox addon called "RESTClient" (http://www.restclient.net) that is useful for quick-and-dirty initial testing (i.e. firing in some simple requests and checking the results/responses) before you go down the route of full-on coding.