# Avnet /IOTCONNECT User API

**Canonical:** https://apis.io/apis/avnet/avnet-iotconnect-user-api/  
**Provider:** Avnet — https://apis.io/providers/avnet/  
**Base URL:** https://user.iotconnect.io  
**Documentation:** https://docs.iotconnect.io/iotconnect/rest-api/user/?env=prod&pf=az

Avnet /IOTCONNECT User API is one of 9 APIs that [Avnet](https://apis.io/providers/avnet/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include IoT, Device Management, Telemetry, and Cloud Platform. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and authentication docs.

Users, roles and the entity hierarchy that scopes devices and permissions inside an /IOTCONNECT tenant. Part of Avnet's /IOTCONNECT IoT platform REST API (50 operations, API version 2); every request carries a JWT bearer token issued by the Authenticate API and the docs page serves the live Swagger 2.0 definition per module, environment and cloud platform (Azure or AWS).

## Operations (50)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v2/Entity` | Add new entity |
| GET | `/api/v2/Entity` | Get entity list with all details |
| PUT | `/api/v2/Entity/{entityGuid}` | Update an entity |
| DELETE | `/api/v2/Entity/{entityGuid}` | Delete an entity |
| GET | `/api/v2/Entity/{entityGuid}` | Get single entity detail |
| GET | `/api/v2/Entity/lookup` | Get entity lookup list |
| PUT | `/api/v2/Entity/{entityGuid}/properties` | Update custom property value |
| DELETE | `/api/v2/Entity/{entityGuid}/property/{propertyGuid}` | Delete custom property value |
| GET | `/api/v2/Entity/bulk-import/history` | Get entity bulk import list |
| POST | `/api/v2/Entity/bulk-import/{parentEntityGuid}/validate` | Validate entities in batch |
| POST | `/api/v2/Entity/bulk-import/{bulkImportGuid}/init` | Initialize bulk entity to import |
| GET | `/api/v2/Entity/bulk-import/{bulkImportGuid}/file` | Get bulk entity import file content |
| DELETE | `/api/v2/Entity/bulk-import/{bulkImportGuid}` | Cancel bulk entity to import |
| POST | `/api/v2/Role` | Add new role |
| PUT | `/api/v2/Role/{roleGuid}` | Update a role |
| DELETE | `/api/v2/Role/{roleGuid}` | Delete a role |
| GET | `/api/v2/Role/{roleGuid}` | Get single role details |
| PUT | `/api/v2/Role/{roleGuid}/status` | Update role status |
| GET | `/api/v2/Role/lookup` | Get role list |
| GET | `/api/v2/Role/role-user` | Get role list with user count |
| POST | `/api/v2/User` | Add new user |
| GET | `/api/v2/User` | Get user list |
| PUT | `/api/v2/User/{userGuid}` | Update user details |
| DELETE | `/api/v2/User/{userGuid}` | Delete user |
| GET | `/api/v2/User/{userGuid}` | Get single user details |
| PUT | `/api/v2/User/{userGuid}/status` | Update user status |
| GET | `/api/v2/User/lookup` | Get user lookup list |
| GET | `/api/v2/role/{roleGuid}/user` | Get user list by role |
| GET | `/api/v2/entity/{entityGuid}/user` | Get user list by entity |
| GET | `/api/v2/User/preference` | Get user preference details |
| PUT | `/api/v2/User/preference` | Update user preference details |
| POST | `/api/v2/User/change-password` | Change password |
| POST | `/api/v2/User/forgot-password` | Forgot password |
| POST | `/api/v2/User/reset-password` | Reset password |
| POST | `/api/v2/User/reset-password/resend` | Resend reset password link |
| PUT | `/api/v2/User/{userGuid}/properties` | Update custom property value |
| DELETE | `/api/v2/User/{userGuid}/property/{propertyGuid}` | Delete custom property value |
| GET | `/api/v2/User/identity` | logged in user detail |
| POST | `/api/v2/User/search` | Get user list by role or user id |
| GET | `/api/v2/User/count` | Get user count |
| GET | `/api/v2/User/{email}/availability` | Get user availability |
| GET | `/api/v2/User/availability` | Get user availability |
| POST | `/api/v2/entity/{entityGuid}/user-import` | Import users in batch |
| GET | `/api/v2/User/announcement` | Get user's announcement list |
| POST | `/api/v2/User/announcement` | — |
| GET | `/api/v2/User/snooze` | Get Snooze Details |
| GET | `/api/v2/User/m-notification` | Get NotificationList |
| GET | `/api/v2/User/enumDetail` | Get Enum Description |
| PUT | `/api/v2/User/minutes/{minutes}/snooze` | Snooze Notifications |
| GET | `/api/v2/User/rh-Config` | Get RHApp Configuration |

## Machine-readable artifacts (8)

- **Documentation** — https://docs.iotconnect.io/iotconnect/rest-api/user/?env=prod&pf=az
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/openapi/avnet-iotconnect-user-openapi.yml
- **OpenAPI** — https://user.iotconnect.io/api/v2/swagger-json
- **OpenAPI** — https://userconsole.iotconnect.io/api/v2.1/swagger-json
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/authentication/avnet-authentication.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/overlays/avnet-iotconnect-user-overlay.yaml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/conventions/avnet-conventions.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/errors/avnet-problem-types.yml

## Other Avnet APIs (8)

- [Avnet API Portal (Procurement APIs)](https://apis.io/apis/avnet/avnet-api-portal-procurement-apis/)
- [Avnet /IOTCONNECT Master API](https://apis.io/apis/avnet/avnet-iotconnect-master-api/)
- [Avnet /IOTCONNECT Authenticate API](https://apis.io/apis/avnet/avnet-iotconnect-authenticate-api/)
- [Avnet /IOTCONNECT Device API](https://apis.io/apis/avnet/avnet-iotconnect-device-api/)
- [Avnet /IOTCONNECT Firmware API](https://apis.io/apis/avnet/avnet-iotconnect-firmware-api/)
- [Avnet /IOTCONNECT Event API](https://apis.io/apis/avnet/avnet-iotconnect-event-api/)
- [Avnet /IOTCONNECT Telemetry API](https://apis.io/apis/avnet/avnet-iotconnect-telemetry-api/)
- [Avnet /IOTCONNECT File API](https://apis.io/apis/avnet/avnet-iotconnect-file-api/)

## Tags

IoT, Device Management, Telemetry, Cloud Platform

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/avnet/avnet-iotconnect-user-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/avnet/.
