Request for API Access in Hosted Agent Setup

Help me!
,
1

Feature(s) impacted

Public API access for triggering webhooks or fetching new user data programmatically.

Observed behavior

Currently, I cannot access or see any options for using the Forest Admin API in my environment. Previously, I recall seeing information suggesting that the API is available with limitations and requires contacting support for activation. However, I can no longer locate these details or proceed with enabling the API.

Expected behavior

I would like to:

  1. Confirm if the Public API is accessible for environments using the Forest Admin Hosted Agent.
  2. Understand the steps required to activate and use the API for my project.
  3. Programmatically retrieve user data (e.g., new user signups) using the API.
  4. Leverage this integration to connect with third-party software for automation purposes.

Alternatively, if the API is not available:

  • Provide guidance on setting up a webhook or other mechanisms to capture and process user signup events for automation workflows.

Context

  • Environment name: Production
  • Agent technology: Hosted Agent (managed by Forest Admin)
  • Agent (forest package) name & version: Agent Version 1.40.0
  • Database type: MongoDB
  • Recent changes made on your end if any: None. I am working with the Forest Admin Hosted Agent setup and haven’t made any recent changes.
2

Hello @Aron ,
Welcome to the community forum !

  1. Forest Admin public API can be used for retrieving activity logs, admin logs, and notes from your project. It works with any type of agent, as it queries the Forest Admin server, not your agent.
  2. The activation of the public API feature is manual and require some action on our side. Can I ask to someone from the sales team to contact you directly about this ?
  3. Currently there is no way of retrieving new user signups using the public API. For user related data, Forest Admin implements the SCIM API for provisioning and removing users to projects. You may manually use this API for retrieving data about users in your project.

There is currently no exploitable event to capture user signups. Maybe some IdP can provide some if you are using SCIM provisioning.

More info about SCIM API:

  • It is mainly intended to be used by supported identity providers, so not all the SCIM spec is implemented. What is supported about retrieving user data:
    • GET /users : list users from your project, paginated. Possibility to query a specific user by email. user data: email, firstName, lastName, role, permissionLevel, team
    • GET /groups : list teams from your project, paginated.
  • The API endpoint is: https://api.forestadmin.com/scim
  • You can generate a SCIM auth token from the security tab of you project: SCIM integration with Okta | User Guide

Kind regards,

Enki