January 2023 Halcyon WebAPI Release Note

Overview:

This document is a summary of additions, changes or enhancement's made to the Halcyon WebAPI interface in the month of January, 2023.

What's New:

No new API endpoints have been created for this release.

What’s Changed:

With the introduction of Role Based Access Control (RBAC), API functionality can be limited based on account role. Below you will see a matrix defining the permission sets for the various access levels, mapped to the available resources. It’s important to remember that the permissions below will be scoped to the role’s group. So while a user with a role for tenant X with a ReadOnly access level has permission to view tenants, that is scoped to just tenant X - meaning listing tenants will only show that user tenant X.

Additionally, it is possible for additional criteria to need to be true in order for a user to actually have the ability to do something. For instance, just because a user is an Admin of their tenant doesn’t mean they can create subtenants. The tenant also has to be authorized to manage tenants first.

	Endpoints		Admin	PowerUser	User	ReadOnly
Tenants	GET: /identity/tenants/{identifier} GET: /identity/tenants GET: /identity/tenants/{identifier}/users GET: /identity/tenants/{tenant_id}/tenants	View
	POST: /identity/tenants/{identifier}/users POST: /identity/tenants/{tenant_id}/tenants	Create
	PUT: /identity/tenants/{identifier}	Update
	DELETE: /identity/tenants/{identifier}/users/{user_id} DELETE: /identity/tenants/{tenant_id}/tenants/{sub_tenant_id}	Delete
Tenant Identity Providers (IdP)	GET: /identity/tenants/{tenant_id}/idp	View
	POST: /identity/tenants/{tenant_id}/idp/{protocol} {protocol} := "oidc" | "saml"	Create
	PUT: /identity/tenants/{tenant_id}/idp/{protocol} {protocol} := "oidc" | "saml"	Update
	DELETE: /identity/tenants/{tenant_id}/idp	Delete
Users	GET: identity/user	View
		Create
	PUT: identity/user PUT: identity/user/password	Update
		Delete
Devices	GET: v1/device/ GET: v1/device/{device_id} GET: v1/device/{device_id}/events GET: v1/device/need-attention GET: v1/device/metrics	View
	DELETE: v1/device/{device_id}	Delete
	GET: v1/device/{device_id}/extracted_keys GET: v1/device/{device_id}/extracted_keys/{extracted_key_id}	Tag
Threats	GET: v1/threat GET: v1/threat/[threat_id]/events?page=1&page_size=10	View
	GET: v1/threat/[threat_id]/download	Download
	POST: v1/threat/[threat_id]/allow	Allow
Extracted Keys	N/A	View
Cloud Inventory	POST: v1/inventory	View
Cloud Connections	N/A	View
	N/A	Create
	N/A	Edit
	N/A	Delete
Installers	N/A	View
		Edit
Events	GET: v1/event/ GET: v1/event/{event_id} GET: v1/event/{event_id}/related GET: /v1/event/metrics GET: /v1/event/metrics-by-month	View
	POST :v1/event/{event_id}/request_threat	Request Threat Upload
Export Configs	GET: config/export GET: config/export/{configId}	View
	POST: config/export	Create
	PUT: config/export/{configId}	Edit
	DELETE: config/export/{configId}	Delete