Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

options

ApproveOptions

Approves a pending member using an ID, email address or approval token.

Tokens must be approved within 30 hours of token creation.
Use the `approvalToken` parameter returned from the
[`register()`](#register) function when approving a member by `token`.

> **Note:**
> A new member's status is `"PENDING"` when the site's membership policy is set to manual approval.
> To learn more about setting your site's membership approval policy, see
> [Editing Your Member Signup Settings](https://support.wix.com/en/article/editing-your-member-signup-settings-for-the-default-form).

Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.

import { authentication } from 'wix-members.v2';

async function approve(options) {
  try {
    const result = await authentication.approve(options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


approve example for dashboard page code

import { authentication } from 'wix-members.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedApprove = elevate(authentication.approve);

export const approve = webMethod(
  Permissions.Anyone,
  async (options) => {
    try {
      const result = await elevatedApprove(options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


approve example for exporting from backend code

approve

ApproveMemberResponse

Options for blocking a member from logging in.

BlockOptions

Blocks a member from logging in to the site using an ID or email address.

To unblock the member and allow them to log in to the site, use the [`approve()`](#approve) function.

import { authentication } from 'wix-members.v2';

async function block(options) {
  try {
    const result = await authentication.block(options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


block example for dashboard page code

import { authentication } from 'wix-members.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedBlock = elevate(authentication.block);

export const block = webMethod(
  Permissions.Anyone,
  async (options) => {
    try {
      const result = await elevatedBlock(options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


block example for exporting from backend code

block

void

string

newEmail

Options for changing a login email address.

ChangeLoginEmailOptions

Changes a member's login email address.

After running this function, the specified member can log in with the new email address. If the member uses social login (for example, Google login) and the member tries to log in with the old email address, they will be re-registered with the old email address.

Site collaborators can use `changeLoginEmail()` to change another member's login email. Members who are not site collaborators can use `changeLoginEmail()` to change their own login email only.

> **Note:** `changeLoginEmail()` cannot be used to change the login email of a site collaborator. Site collaborators can change their login emails from their Wix [account settings](https://manage.wix.com/account/account-settings).

import { authentication } from 'wix-members.v2';

async function changeLoginEmail(id, newEmail, options) {
  try {
    const result = await authentication.changeLoginEmail(id, newEmail, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


changeLoginEmail example for dashboard page code

import { authentication } from 'wix-members.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedChangeLoginEmail = elevate(authentication.changeLoginEmail);

export const changeLoginEmail = webMethod(
  Permissions.Anyone,
  async (id, newEmail, options) => {
    try {
      const result = await elevatedChangeLoginEmail(id, newEmail, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


changeLoginEmail example for exporting from backend code

changeLoginEmail

ChangeLoginEmailResponse

email

password

LoginOptions

Logs in a registered member with an email and password.

The `login()` function only works with existing members. To register a new member use the [`register()`](#register) function.

To complete the login, the returned session token must be applied using the `applySessionToken()` function in the wix-members-frontend API.

import { authentication } from 'wix-members.v2';

async function login(email, password, options) {
  try {
    const result = await authentication.login(email, password, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


login example for dashboard page code

import { authentication } from 'wix-members.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedLogin = elevate(authentication.login);

export const login = webMethod(
  Permissions.Anyone,
  async (email, password, options) => {
    try {
      const result = await elevatedLogin(email, password, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


login example for exporting from backend code

login

LoginResponse

Login email address for the new site member.

Password the new site member will use to log in.

Must be 4 to 15 ASCII-printable characters.

RegisterOptions

Registers a new site member.

The specified `password` must be between 4 and 100 ASCII characters.

>**Note:** The `register()` function behaves differently depending on your site's [member signup settings](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-members/enabling-custom-site-registration).

import { authentication } from 'wix-members.v2';

async function register(email, password, options) {
  try {
    const result = await authentication.register(email, password, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


register example for dashboard page code

import { authentication } from 'wix-members.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedRegister = elevate(authentication.register);

export const register = webMethod(
  Permissions.Anyone,
  async (email, password, options) => {
    try {
      const result = await elevatedRegister(email, password, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


register example for exporting from backend code

register

RegisterResponse

Login email of the member whose password will be set.

SendSetPasswordEmailOptions

Sends a site member an email with a link to set their password.

The set password link is valid for 3 hours,
and it can be used only once.
If the link expires, the original password remains.

import { authentication } from 'wix-members.v2';

async function sendSetPasswordEmail(email, options) {
  try {
    const result = await authentication.sendSetPasswordEmail(email, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


sendSetPasswordEmail example

import { authentication } from 'wix-members.v2';
import { webMethod, Permissions } from 'wix-web-module';

export const sendSetPasswordEmail = webMethod(
  Permissions.Anyone,
  async (email, options) => {
    try {
      const result = await authentication.sendSetPasswordEmail(email, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


sendSetPasswordEmail example for exporting from backend code

sendSetPasswordEmail

SendSetPasswordEmailResponse

velo-deps_wix-members.v2_authentication

Address

city

2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.

country

postalCode

region

street

AppleLogin

JWT signed by apple, contains target (aud), email etc

token

session

Session

Login email address of the member to approve.

BatchGetMembersResponse

members

BatchGetOptions

unique identifier of the requested member(required)

includeContactDetails

boolean

includeGroupsDetails

Login email address of the member to block.

Member with the updated login email address.

member

Member

CustomField

dateValue

numValue

strValue

name

DeleteOptions

isBulkAction

DialogData

appId

initiator

visitorId

EmailVerification

6-digit code for verification.  Code can be between 100000 and 999999.

verificationId

FacebookLogin

AccessToken created by Facebook, used to later fetch details over API

FilterBy

groupId

privacyStatus

SiteMemberPrivacyStatus

roles

status

GetAuthorizedPagesOptions

GetAuthorizedPagesResponse

authorizedPages

GetMemberResponse

GetMemberRoleResponse

contactId

member's role:

`OWNER` - member that belongs to site owner
`CONTRIBUTOR` - member that belongs to a contributor in site
`MEMBER` - other members that registered to site

role

Role

SiteMemberStatus

userId

GetMemberRolesResponse

idsToRoles

GetOptions

GetResetPasswordLinkResponse

Reset password link.
Valid for one use, up to two weeks from when it is created.

resetPasswordLink

GetRolesOptions

GetUserMembershipsOptions

paging - offset and limit ( the max limit for page is 200)

paging

Paging

GetUserMembershipsResponse

sequence of member's of the user with there metaSiteId

userMemberships

GoogleLogin

JWT signed by Google, contains target (aud), email etc

Group

type

ListMembersResponse

pagination

PaginationResponse

ListOptions

partial response request - list of field names to get back in response

fields

for paging - maximum number of records to retrieve

limit

number

offset

sort order - list of field and direction tuples. e.g. `["first_name:asc", "last_name:desc"]`

order

addresses

Date and time when the member was created.

creationDate

Custom fields, structured as key:object pairs. Custom field keys are defined in the Contacts Extended Fields API. The paired object contains the `name` and `value` properties, where `name` is the display name and `value` is the value stored for the member.

Only custom fields added to the member profile in the Dashboard are available through the Members API. Empty fields are not returned.

When updating a member, `name` is ignored.

customFields

emails

firstName

Date and time when the member last logged in to the site.

lastLoginDate

lastName

Date and time when the member was last updated.

lastUpdateDate

Email used by the member to log in to the site.

loginEmail

Name that identifies the member to other members. Displayed on the member's profile page and interactions in the forum or blog.

nickname

phones

picture

Member privacy status.

One of:
- `"PUBLIC"`: Member is visible to everyone.
- `"PRIVATE"`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
- `"UNKNOWN"`: Insufficient permissions to get the status.

profilePrivacyStatus

URL segment that determines the member's profile page.

slug

Member site access status.

One of:
- `"PENDING"`: Member created and is waiting for approval by site owner.
- `"APPROVED"`: Member can log in to the site.
- "OFFLINE"`: Member is a guest author for the site blog and cannot log in to the site.
- `"BLOCKED"`: Member is blocked and cannot log in to the site.
- `"UNKNOWN"`: Insufficient permissions to get the status.

MemberContactInfo

Any number of custom fields.
[Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
are used to store additional information about your site's contacts.
When setting a custom field, use key:value pairs,
where the key matches the names defined in your site's
[Contact List](https://support.wix.com/en/article/accessing-your-contact-list).
You can only set values for custom fields that already exist in the Contacts application.

labels

MemberRole

indication that the total count was too expensive to calculate

tooManyToCount

total

Number of items to skip in the current sort order.

QueryMembersResponse

QueryOptions

includeOfflineMembers

query - See https://github.com/wix-private/platformization-guidelines/blob/master/Server/API-Query.md
supported fields: `id`, `login_email`, `status`, `language`, `date_created`, `last_update_date`, `flags`, `name`, `first_name`, `last_name`, `nickname`, `email_verified`, `privacy_status`

query

Contact information for the registered member.

contactInfo

Sets the privacy status of a new member upon registration.

- `PUBLIC`: Member is visible to everyone.
- `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
- `UNKNOWN`: Insufficient permissions to get the status.

in case the site requires members approval, the registered member
will be an applicant until he's approved. the token can be used as a member
identifier for approval using the `MembersService.Approve` API

approvalToken

in case the site is open for registration, all members are automatically
approved. they will get a temporary token for obtaining a valid session

ResetPasswordResponse

Indicates if the request was successfully received.

changeLoginEmail( )