api/emailauth

This file contains the readily available functions which interact with the ITSLanguage user API. Users can have email based credentials. These credentials can be managed using the REST API. Only users with administrative powers can perform these calls.

Source:
See:

Methods

(static) create(emailAuth, userIdopt) → {Promise}

Source:

Create an emailAuth for either the current user or a user provided with an userId. To create an email auth for another user you could pass the userId but depending on permissions it could also be possible to use impersonation for this.

Parameters:
Name Type Attributes Default Description
emailAuth string

The Id of the user to create or overwrite a profile for.

Properties
Name Type Attributes Description
email string

A unique email address.
password string <optional>

A secure password, if none is given, it will be generated.
userId string <optional>
 null

The Id of the user to create an emailAuth for.
Returns:
  • The emailAuth creation promise.
Type
Promise

(inner) url(userIdopt) → {string}

Source:

The URL for the emailAuth handler. According to the docs the following URL's are valid to be used for emailauth interaction.

  • POST /users/emailauth.
  • POST /users/:userId/emailauth.
Parameters:
Name Type Attributes Description
userId string <optional>

The id of the user to interact with emailauth API.
Returns:
  • A composed URL to use for requests.
Type
string