setUserPasswordCompromised method

Future<User?> setUserPasswordCompromised(String userId, { SetUserPasswordCompromisedRequest? setUserPasswordCompromisedRequest, })

Set a user's password as compromised

Sets the given user's password as compromised. The user will be prompted to reset their password on their next sign-in.

Parameters:

• String userId (required): The ID of the user to set the password as compromised

• SetUserPasswordCompromisedRequest setUserPasswordCompromisedRequest:

Implementation

Future<User?> setUserPasswordCompromised(
  String userId, {
  SetUserPasswordCompromisedRequest? setUserPasswordCompromisedRequest,
}) async {
  final response = await setUserPasswordCompromisedWithHttpInfo(
    userId,
    setUserPasswordCompromisedRequest: setUserPasswordCompromisedRequest,
  );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty &&
      response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(
      await _decodeBodyBytes(response),
      'User',
    ) as User;
  }
  return null;
}