About the Users API

The Users API enables account owners to manage their account's team members access to account assets. Through this API, you can access team member data and roles, including open invites, and assign and unassign team member roles to each asset, ensuring that each team member has the appropriate level of access to the different assets within the account.

Use cases

• Manage company employees' account access.

Terminology

• Assignment: The mapping of a Wix user's access to an asset and their assigned role. For example, Sally has access to the XYZ site owned by Jennifer with a website manager role, and Alice has access to Selena’s Wix account with a co-owner role.
• Facet: A type of filter that divides items into logical subdivisions, and counts the number of items in each. See Filters and Facets: An Explainer for more information.
• Policy: See Role below.
• Restriction: The asset a user is assigned access to in an assignment, including any restrictions to their access.
• Role: A defined type of access that an identity should have on a specific site or account. Wix provides several predefined roles, such as co-owner, website manager, and website designer. Account owners and co-owners can also define their own custom roles.
• Subject: The identity assigned to the asset in an assignment. Supported subjects include user IDs, account IDs, and app IDs.
• Team: The group of Wix users that are team members of an account.
• Team member: A Wix user that has been added to an account, with access to one or more sites and other assets. One Wix user can be a team member of multiple accounts.
• User: A logged in user on *.wix.com.

Sample Flows

This article shares some typical use cases you can support, as well as an example flow that supports each use case. You're certainly not limited to these use cases, but they can be a helpful jumping off point as you plan your implementation.

Periodically check and update company employees' account access

If your company has a Wix account with employees as team members, you may want to periodically check the access that each team member has to your account assets and the roles they have for each site.

1. Call Search Team with any relevant filters.
2. Review the returned lists of users and invites, and their assignments.
3. If relevant, call Get Roles Info with any relevant filters, to retrieve a list of all roles that can be applied to your account's team members.
4. If changes should be made to any team member's roles or access to account assets, call Update Team Member Assignments.
5. If an employee leaves, or should have their access removed for any reason, call Remove Member.