Developing workflows using the Micetro REST API client - Platform - BlueCat Gateway - 24.3.3

Gateway Administration Guide

ft:locale
en-US
Product name
BlueCat Gateway
Version
24.3.3

You can create Gateway workflows based on Python and Flask that run on the Gateway platform that can make calls to a Micetro server using the Micetro REST API. Users can build applications as Gateway workflows that requires integration with Micetro. The same benefits that Gateway workflows provide for integrating with BlueCat Address Manager apply to workfows that integrate with Micetro.

The Gateway platform handles authentication with the Micetro server and provides workflows with an already authenticated client to the Micetro REST API, similar to how it handles authentication with an instance of BlueCat Address Manager. Gateway also provides an already authenticated client to the BlueCat Address Manager REST v1 or v2 APIs. While workflow developers can set up custom authentication code for applications with complex security requirements, in most cases Gateway can handle all of it automatically.

Gateway creates a session after authenticating with Micetro. The Micetro session will not time out unless the user logs out of Gateway. Gateway cannot authenticate with both Micetro and BAM at the same time.

For more details about Micetro authentication in the BlueCat Python Web Framework, see Micetro Authentication.

Using the Micetro API client

Gateway provides workflows with an already-authenticated client to the Micetro REST API through the global user field g.user.micetro_api.v2 of type class MicetroAPI. For more details, see About the MicetroAPI class.