Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

For this model the filter (Connection API) and the query(Rest API) parameters will be ignored.
The searchparameter should be used instead. The search query parameter is a simple string and will be transformed into filter shown below:

Code Block
{
  "$or": [
    { "name": { "$regex": "exampleSearchString", "$options": "i" } },
    { "email": { "$regex": "exampleSearchString", "$options": "i" } }
  ]
}

SCHEMA

Name

Description

_id

The id of this user.

name

Name of the user.

email

The email of the user.

organisations

A list of organisation ids that this user belongs to.

organisationSettings

A list of organisation settings for this user

imageUrl

A url of an image for this user.

googleId

The user’s google id.

ownerOrganisation

The id of the users owning organisation

ownerOrganisationSettings

Duplication of organisation settings.

settings

An object of specific users settings. see settings

scopes

Global scopes for this user.

verified

Whether this user has been verified.

resetTokens

A list of reset tokens. See reset token.

passwordHistory

A list of users previously used password hashes.

authLastAttempt

When the user last attempted to authenticate.

authFailedAttempts

Number of failed authentication attempts.

authLockoutExpiry

When the user can attempt to authenticate again.

...