# Avnet User API

**Canonical:** https://apis.io/apis/avnet/avnet-user-api/  
**Provider:** Avnet — https://apis.io/providers/avnet/  
**Base URL:** https://apigw.avnet.com  
**Documentation:** https://apiportal.avnet.com/

Avnet User API is one of 36 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 User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

User Api List

## Operations (60 of 62)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v2.1/User` | Add new user |
| GET | `/api/v2.1/User` | Get user list |
| PUT | `/api/v2.1/User/{userGuid}` | Update user details |
| DELETE | `/api/v2.1/User/{userGuid}` | Delete user |
| GET | `/api/v2.1/User/{userGuid}` | Get single user details |
| PUT | `/api/v2.1/User/{userGuid}/status` | Update user status |
| GET | `/api/v2.1/User/lookup` | Get user lookup list |
| GET | `/api/v2.1/role/{roleGuid}/user` | Get user list by role |
| GET | `/api/v2.1/entity/{entityGuid}/user` | Get user list by entity |
| GET | `/api/v2.1/User/preference` | Get user preference details |
| PUT | `/api/v2.1/User/preference` | Update user preference details |
| POST | `/api/v2.1/User/change-password` | Change password |
| POST | `/api/v2.1/User/forgot-password` | Forgot password |
| POST | `/api/v2.1/User/reset-password` | Reset password |
| POST | `/api/v2.1/User/reset-password/resend` | Resend reset password link |
| PUT | `/api/v2.1/User/{userGuid}/properties` | Update custom property value |
| DELETE | `/api/v2.1/User/{userGuid}/property/{propertyGuid}` | Delete custom property value |
| GET | `/api/v2.1/User/identity` | logged in user detail |
| POST | `/api/v2.1/User/search` | Get user list by role or user id |
| GET | `/api/v2.1/User/count` | Get user count |
| GET | `/api/v2.1/User/{email}/availability` | Get user availability |
| POST | `/api/v2.1/entity/{entityGuid}/user-import` | Import users in batch |
| GET | `/api/v2.1/User/announcement` | Get user's announcement list |
| POST | `/api/v2.1/User/announcement` | Create api user announcement |
| GET | `/api/v2.1/User/Notification` | Get user NotificationList |
| GET | `/api/v2.1/User/m-notification` | Get Registered Platform NotificationList |
| PUT | `/api/v2.1/User/deviceToken/{deviceToken}/minutes/{minutes}/snooze` | Snooze the Notification for specific device |
| PUT | `/api/v2.1/User/m-register/platform/{platformType}/deviceToken/{deviceToken}` | RegisterDevice Platform |
| DELETE | `/api/v2.1/User/m-register/platform/{platformType}/deviceToken/{deviceToken}` | Remove the RegisterDevice Platform |
| GET | `/api/v2.1/User/enumDetail` | Get Enum Description |
| GET | `/api/v2.1/User/rh-Config` | Get RHApp Configuration |
| GET | `/api/v2.1/cognito/user` | Get Cognito user list |
| 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` | Create api 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 |

…and 2 more operations. They are listed in full on the page.

## Machine-readable artifacts (14)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/openapi/avnet-user-api-openapi.yml
- **Documentation** — https://docs.iotconnect.io/iotconnect/rest-api/master/?env=prod&pf=az
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/authentication/avnet-authentication.yml
- **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
- **Documentation** — https://docs.iotconnect.io/iotconnect/rest-api/auth/?env=prod&pf=az
- **Documentation** — https://docs.iotconnect.io/iotconnect/rest-api/user/?env=prod&pf=az
- **Documentation** — https://docs.iotconnect.io/iotconnect/rest-api/device/?env=prod&pf=az
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/data-model/avnet-data-model.yml
- **Documentation** — https://docs.iotconnect.io/iotconnect/rest-api/firmware/?env=prod&pf=az
- **Documentation** — https://docs.iotconnect.io/iotconnect/rest-api/event/?env=prod&pf=az
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/asyncapi/avnet-iotconnect-webhooks.yml
- **Documentation** — https://docs.iotconnect.io/iotconnect/rest-api/telemetry/?env=prod&pf=az
- **Documentation** — https://docs.iotconnect.io/iotconnect/rest-api/file/?env=prod&pf=az

## Other Avnet APIs (12)

- [Avnet API Portal (Procurement APIs)](https://apis.io/apis/avnet/avnet-api-portal-procurement-apis/)
- [Avnet ADU Group API](https://apis.io/apis/avnet/avnet-adugroup-api/)
- [Avnet Attribute API](https://apis.io/apis/avnet/avnet-attribute-api/)
- [Avnet Auth API](https://apis.io/apis/avnet/avnet-auth-api/)
- [Avnet Azure Sphere API](https://apis.io/apis/avnet/avnet-azuresphere-api/)
- [Avnet Certificate API](https://apis.io/apis/avnet/avnet-certificate-api/)
- [Avnet Cloud Template API](https://apis.io/apis/avnet/avnet-cloudtemplate-api/)
- [Avnet Command API](https://apis.io/apis/avnet/avnet-command-api/)
- [Avnet Deployment API](https://apis.io/apis/avnet/avnet-deployment-api/)
- [Avnet Device API](https://apis.io/apis/avnet/avnet-device-api/)
- [Avnet Device Operation API](https://apis.io/apis/avnet/avnet-deviceoperation-api/)
- [Avnet Device Update API](https://apis.io/apis/avnet/avnet-deviceupdate-api/)

## Tags

User

---

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