The User Management API enables you to create, retrieve, update, and delete users within Avaya Infinity™. Users are identified by a unique 26-character user ID (prefixed 002) or by email address. The license type assigned to a user controls their available channels, permissions, and workspace configuration.
Endpoints
Get List of Users
GET /users
Retrieve a paginated list of users with optional filtering by status, license type, folder, location, and date range. Query parameters control whether related data such as group memberships, E911 location details, and CRM configuration are included in the response.
Create a User
POST /users
Create a new user. At a minimum, a user requires an email address, first and last names, and either a license type or a profile ID. License type determines the default permissions, spaces, and channel access applied to the user.
Get User Details
GET /users/USERIDOREMAIL
Retrieve detailed configuration for a specific user, including permissions, queue assignments, and related data. The path parameter accepts either the user's 26-character ID or their email address.
Update a User
PATCH /users/USERIDOREMAIL
Update one or more properties of a user. The user can be identified by ID or email address. Agents editing their own profile are subject to self-edit restrictions; identity fields such as name and email can only be modified by an administrator.
Delete a User
DELETE /users/USERID
Permanently delete a user. Only users in the disabled state can be deleted. Use the Update a User endpoint to disable a user before deletion.
Getting Started
Use the Get List of Users endpoint to discover existing users and their IDs. To provision a new user, call Create a User with the required fields and the appropriate license type for their role. Once created, use Update a User to modify configuration or change status. To remove a user, first disable them via Update a User, then call Delete a User.