Unifi icon

Unifi

Interact with Unifi API

Internet Access Control → Set Access

AI-generated

Summary

Set the internet access control settings for a specified client on a given Unifi site by configuring network access, fixed IP usage, and user group.

Inputs

  • siteId (required) — The identifier of the Unifi site where the client resides, taken from the 'name' field of the 'List All Clients' response.
  • clientId (required) — The Client ID to specify which client's internet access control is being set.
  • useFixedIp (required) — Boolean flag indicating whether to assign a fixed IP address to the client.
  • networkAccess (required) — The network access level or policy to apply to the client.
  • fixedIp (required) — The fixed IP address to assign to the client if 'useFixedIp' is true.
  • usergroupId (required) — The user group ID in which the client should be placed.

Output shape

a single JSON object reflecting the updated client internet access control configuration as returned by the Unifi API

The output is the direct result of the API request to set access. It does not support pagination or multiple results for this operation and expects all required inputs to be supplied. In case of errors, an error message will be provided.

Discussion