createEmailToken method

Future<Token> createEmailToken({
  1. required String userId,
  2. required String email,
  3. bool? phrase,
})

Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the POST /v1/account/sessions/token endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.

A user is limited to 10 active sessions at a time by default. Learn more about session limits.

Implementation

Future<models.Token> createEmailToken({
  required String userId,
  required String email,
  bool? phrase,
}) async {
  final String apiPath = '/account/tokens/email';

  final Map<String, dynamic> apiParams = {
    'userId': userId,
    'email': email,
    'phrase': phrase,
  };

  final Map<String, String> apiHeaders = {'content-type': 'application/json'};

  final res = await client.call(
    HttpMethod.post,
    path: apiPath,
    params: apiParams,
    headers: apiHeaders,
  );

  return models.Token.fromMap(res.data);
}