Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

options

GetRolesInfoOptions

Retrieves all available roles in the requesting account, including predefined and custom roles.
> **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.

import { createClient, ApiKeyStrategy } from "@wix/sdk";
import { users } from "@wix/user-management";
const wixClient = createClient({
 modules: { users },
 auth: ApiKeyStrategy({
    apiKey: "MY-API-KEY",
  }),
});

async function getRolesInfo(options) {
  const response = await users.getRolesInfo(options);
}


Get available account roles with an API key

getRolesInfo

GetRolesInfoResponse

userId

string

Removes a team member from the requesting account.
> **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.

import { createClient, ApiKeyStrategy } from "@wix/sdk";
import { users } from "@wix/user-management";
const wixClient = createClient({
 modules: { users },
 auth: ApiKeyStrategy({
    apiKey: "MY-API-KEY",
  }),
});

async function removeMember(userId) {
  const response = await users.removeMember(userId);
}


Remove a team member from an account with an API key

removeMember

void

SearchTeamOptions

Retrieves all team members of the requesting account, based on the provided filters and free text queries.
> **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.

import { createClient, ApiKeyStrategy } from "@wix/sdk";
import { users } from "@wix/user-management";
const wixClient = createClient({
 modules: { users },
 auth: ApiKeyStrategy({
    apiKey: "MY-API-KEY",
  }),
});

async function searchTeam(options) {
  const response = await users.searchTeam(options);
}


Get account team members with an API key

searchTeam

SearchTeamResponse

Filter options. The `assignmentIdsToRemove` and `newAssignments` fields **must** be passed.

UpdateTeamMemberAssignmentsOptions

Updates the assignments of roles and conditions for an existing team member.  Changing assignments changes the team member’s access to account assets.
> **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.

import { createClient, ApiKeyStrategy } from "@wix/sdk";
import { users } from "@wix/user-management";
const wixClient = createClient({
 modules: { users },
 auth: ApiKeyStrategy({
    apiKey: "MY-API-KEY",
  }),
});

async function updateTeamMemberAssignments(userId, options) {
  const response = await users.updateTeamMemberAssignments(userId, options);
}


Update a team member's assignments with an API key

updateTeamMemberAssignments

UpdateTeamMemberAssignmentsResponse

# 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.     

<blockquote class="important">
  <strong>Important:</strong>
  
This API manages team members within accounts, and is not intended for managing customer access to individual sites.</blockquote>

## Use cases
- [Manage company employees' account access](https://dev.wix.com/docs/sdk/account-level-modules/user-management/users/sample-flows#account-level-modules_user-management_users_periodically-check-and-update-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](https://medium.com/@westontt/filters-and-facets-an-explainer-3b73a9538eca) 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.


To use the Users API, install the `@wix/user-management` package using npm or Yarn:
  ```console
npm install @wix/user-management
```

or

```console
yarn add @wix/user-management
```

Then import `{ users }` from `@wix/user-management`:

```js
import { users } from '@wix/user-management'
```
  

# 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](https://dev.wix.com/docs/sdk/account-level-modules/user-management/users/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](https://dev.wix.com/docs/sdk/account-level-modules/user-management/users/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](https://dev.wix.com/docs/sdk/account-level-modules/user-management/users/update-team-member-assignments).
5. If an employee leaves, or should have their access removed for any reason, call [Remove Member](https://dev.wix.com/docs/sdk/account-level-modules/user-management/users/remove-member).


user-management_users

ApiCondition

conditionType

ConditionAttributeType

Expected value of the condition. When `conditionType` = "FOLDER", this is the folder path.

value

ApiResource

resourceType

ResourceType

AssignedSubject

subjectType

SubjectType

AssignmentV3

assignmentId

Role assigned to the user. To retrieve all available roles, call Get Roles Info.

policyId

The asset where a user is assigned access in an assignment. When empty, the role covers all assets, with no restrictions to specific sites or folders.

restrictions

Restriction

Identity assigned to the asset in an assignment, referred to as subject. Supported subjects include user IDs, account IDs, and app IDs.

subject

Conditions

conditions

Direction

EditorType

Facet

facetType

FacetType

Values and their counters. Values with count = 0 are not returned.

values

FacetValue

count

number

Supported values: `Roles`, `InviteStatus`, `Users`.

filter

RolesInfoFilter

Language of predefined roles names and descriptions to return, in ISO 639 format. Default: `en`.

locale

customRoles

predefinedRoles

InviteAssignmentV3

Role ID that will be assigned once the invite is accepted.

Assets where the user will be assigned access. When empty, the role covers all assets, with no restrictions to specific sites or folders.

InviteStatus

InviteV3

acceptLink

A list of assignments that will be applied to the invitees when they accept the invite.

assignments

dateCreated

dateUpdated

email

expirationDate

status

Name

firstName

lastName

OrderField

Ordering

direction

fieldName

Paging

limit

Number of items to skip in the current sort order.

offset

List of conditions restricting the user's access. Currently only folder conditions are supported.

resource

Site where the assignment restrictions apply.

site

RoleInfo

Role description, translated according to the request locale. If translation fails, the original description is returned.

description

Whether this role is restricted from accessing a specific resource type. Default: `NoRestriction`.

restrictFromLevel

RoleLevelRestriction

Role title, translated according to the request locale. If translation fails, the original title is returned.

title

RoleLevel

Filter for editor-specific roles. Default: ALL.

editorTypes

roleLevel

A list of facets to return in the response. Facets count the items within logical groupings.
See [Filters and Facets: An Explainer](https://medium.com/@westontt/filters-and-facets-an-explainer-3b73a9538eca) for more information.

facets

Filter object. Supported values: `inviteType` and `roleId`. For example, `{'inviteType': {'$eq': 'Expired'}}`.
See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.

orderBy

paging

Free text to search for within team member name and email address fields.

query

Existing team members and invites sent to join the account.

teamMembers

SiteRestriction

TeamMemberV3

invite

user

Existing assignment IDs to remove. To retrieve all existing assignment IDs for a team member, call Search Team.

removeMember( )